Merge pull request #7174 from braze-inc/bd-2982

BD-2982 Update Shopify back-in-stock notifications article

_docs/_partners/message_orchestration/channel_extensions/ecommerce/shopify/shopify_features/shopify_catalogs/back_in_stock.md

@@ -14,31 +14,45 @@ description: "This reference article describes how to create back-in-stock notif
 Back-in-stock notifications for Braze Shopify catalogs are currently in early access. Contact your account manager if you're interested in participating in this early access.
 {% endalert %}
 
-## How it works
+When a customer clicks an item, we'll automatically subscribe them to receive back-in-stock notifications for that item. Once the item's inventory quantity is greater than zero, all subscribers will be eligible for notifications through a campaign or Canvas. However, only users who opted into notifications will receive notifications. 
 
-Back-in-stock notifications are determined by notification rules. Subscription statuses will be observed, so if the user has not opted in to notifications, they will be filtered out and will not receive notifications.
+## How back-in-stock notifications work
 
-Note that users are only subscribed for 90 days. If an item isn't back in stock within 90 days, the user is removed from the subscription. Braze will process up to 10 item updates per minute. This means if you update 11 items in one minute, only the first 10 items will trigger the back-in-stock notification.
+As a Braze Shopify user with a Shopify catalog, you have a field called `inventory_quantity` that's synced from Shopify to Braze. Your Shopify users will send a `shopify_product_clicked` event when they click an item. This event and the Shopify catalog data will subscribe your users to back-in-stock notifications.
+
+When an item has an `inventory_quantity` that meets your inventory rule, we'll look up all your users who are subscribed to that item (users who clicked the item) and send a Braze custom event that you can use to trigger a campaign or Canvas.
+
+The event properties are sent alongside your user, so you can template in the item details into the campaign or Canvas that sends!
+
+## Prerequisities
+
+- Use the Braze Shopify integration
+- Use Braze Shopify catalogs
+- Enable the back-in-stock feature flag
 
 ## Setting up back-in-stock notifications
 
 Follow these steps to set up back-in-stock notifications in a specific catalog.
 
-1. Go to your catalog and click the **Settings** tab.
-2. Select the **Back in stock** toggle.
-3. Set your notification rule. There are two options: **Notify all subscribed users** and **Notify a certain number of users per a certain number of minutes**. <br>Selecting **Notify all subscribed users** notifies all customers who are waiting when the item is back in stock. **Notify a certain number of users per a certain number of minutes** notifies a specified number of customers per your configured notification period. Braze will notify the specified numbers of customers in increments until there are no more customers to notify, or until the item goes out of stock. Your notification rate cannot exceed notifying 10,000 users per minute.
+1. Go to your catalog and select the **Settings** tab.
+2. Set your notification rule. There are two options:
+    - **Notify all subscribed users** notifies all customers who are waiting when the item is back in stock. 
+    - **Notify a certain number of users per a certain number of minutes** notifies a specified number of customers per your configured notification period. Braze will notify the specified numbers of customers in increments until there are no more customers to notify, or until the item goes out of stock. Your notification rate cannot exceed notifying 10,000 users per minute.
+3. Select the **Back in stock** toggle.
+4. Select the **Inventory field in catalog** as `inventory_quantity`. This will check the Shopify `inventory_quantity` field within your product syncs. If the value is greater than zero, then customers that are subscribed will be eligible to receive the back in stock notification.
+5. Save your settings.
 
-![Catalog settings that show the back in stock feature turned on. The notification rules are to notify a thousand users every ten minutes.][1]
+![Catalog settings that show the back in stock feature turned on. The notification rules are to notify a thousand users every ten minutes.][1]{: style="max-width:70%;"}
 
 {% alert important %}
 Notification rules in these settings do not replace Canvas notification settings, such as Quiet Hours.
 {% endalert %}
 
-## Using back-in-stock notifications in Canvas
+## Using back-in-stock notifications in a Canvas or campaign
 
-After setting up the back-in-stock feature in a catalog, follow these steps to use with Canvas.
+After setting up the back-in-stock feature in a catalog, follow these steps to use with a Canvas or campaign.
 
-1. Set up an action-based Canvas.
+1. Set up an action-based Canvas or campaign.
 2. Select **Back in stock** as the trigger.
 3. Select the name of the catalog with the back-in-stock notifications.
 4. Continue [setting up]({{site.baseurl}}/user_guide/engagement_tools/canvas/create_a_canvas/create_a_canvas/) your Canvas as you would.
@@ -49,28 +63,24 @@ Now, your customers can be notified when an item is back in stock.
 {% raw %}
 To template in details about the catalog item that's back in stock, you can use the `canvas_entry_properties` Liquid tag to access the `item_id`. 
 
-Using ``{{canvas_entry_properties.${catalog_update}}}`` will return the ID of the item that came back in stock.
-Use this Liquid tag  ``{% catalog_items <name_of_your_catalog> {{canvas_entry_properties.${catalog_update}}} %}`` at the top of your message, then use ``items[0].<field_name>` to access data about that item throughout the message.
+To return the ID of the item that is back in stock, use the Liquid tag ``{{canvas_entry_properties.${catalog_update}}}``. To access data about that item throughout your message, put the Liquid tag  ``{% catalog_items <name_of_your_catalog> {{canvas_entry_properties.${catalog_update}}} %}`` at the top of your message, then use ``items[0].<field_name>` to place the data in your message.
 {% endraw %}
 
-## Connecting an email capture form
-
-If you have an [email capture form]({{site.baseurl}}/user_guide/message_building_by_channel/in-app_messages/drag_and_drop/templates/email_capture/) to collect user interest in a specific product, you can connect the form to back-in-stock notifications and subscribe users to product updates. To do this, you’ll create a custom event after capturing a user’s email address. You'll then use the [`/users/track`]({{site.baseurl}}/api/endpoints/user_data/post_user_track#example-request-for-updating-a-user-profile-by-email-address) endpoint to update the user when you send the custom event. 
-
-When you send Braze a `/users/track` request with only an email address, we will search for a user profile with that existing email address and subscribe the user. If we can’t find that email address, we’ll create a new user profile with only an email address so that they can receive messaging too.
+Here is a sample Liquid template that will display the item's product title, image URL, and price:
 
-### Step 1: Create a custom event to subscribe a user from updates
-
-You'll need these custom event properties to map to the catalog attributes:
-
-- `email_address`
-- `product_id` with a value corresponding to the catalog item. If you have a different event property name like `product_name` or `product ID`, you can map those names to `product_id` in the Braze platform.
-- `catalog_name` with a value corresponding to the catalog name. This is optional, but if you don’t have one you must set a default catalog for Braze to reference in the Braze platform.
-
-### Step 2: Create a custom event to remove a user from updates (optional)
+{% raw %}
+```liquid
+{% catalog_items shop-1234_shopify_catalog {{canvas_entry_properties.${catalog_update}.item_id}} %}
+{{ items[0].shopify_product_title }}
+{{ items[0].product_image_url }}
+{{ items[0].price }}
+```
+{% endraw %}
 
-If you don’t have a custom event to remove a user, users will automatically be removed after 90 days. You'll need the same attributes in Step 1 to create this custom event.
+## Considerations
 
-After you create your custom event, your email capture form will subscribe users to updates for that specific product.
+- Users are only subscribed for 90 days. If the item isn't back in stock in 90 days, the user is unsubscribed.
+- When using the **Notify all subscribed users** notification rule, Braze will notify 100,000 over 10 minutes.
+- Braze will process at most 10 item updates over one minute. If you update 11 items in one minute, only the first 10 can trigger a back-in-stock notification.
 
 [1]: {% image_buster /assets/img/back_in_stock_settings.png %} 

_docs/_user_guide/personalization_and_dynamic_content/catalogs/back_in_stock_notifications.md

@@ -13,13 +13,15 @@ description: "This reference article describes how to create back-in-stock notif
 Back-in-stock notifications for catalogs are currently in early access. Contact your account manager if you're interested in participating in this early access.
 {% endalert %}
 
-## How it works
+When a user triggers a custom event for an item, we'll automatically subscribe them to receive back-in-stock notifications for that item. Once the item's inventory quantity meets your inventory rule (such as an inventory larger than 100), all subscribers will be eligible for notifications through a campaign or Canvas. However, only users who opted into notifications will receive notifications. 
 
-When the selected custom event is performed by a user, it can be used to create a back-in-stock subscription for a combination of that user and catalog item that it occurred for, if the item's inventory field is currently at 0. Once the item is back in stock, users can be notified through a Canvas.
+## How back-in-stock notifications work
 
-Back-in-stock notifications are determined by notification rules. If the user has not opted in to notifications, they will be filtered out and will not receive messaging.
+You'll set up a custom event to use as a subscription event, such as a `product_clicked` event. This event must contain a property of the item ID (catalog item IDs). We suggest you include a catalog name, but this isn't required. You'll also provide the name of an inventory quantity field, which must be a number-data type.
 
-Users are only subscribed for 90 days. If an item isn't back in stock within 90 days, the user is removed from the subscription. Braze will process up to 10 item updates per minute. This means if you update 11 items in one minute, only the first 10 items will trigger the back-in-stock notification.
+When an item has an inventory quantity that meets your inventory rule, we'll look up all your users who are subscribed to that item (users who did the subscription event) and send a Braze custom event that you can use to trigger a campaign or Canvas.
+
+The event properties are sent alongside your user, so you can template in the item details into the campaign or Canvas that sends!
 
 ## Setting up back-in-stock notifications
 
@@ -35,8 +37,10 @@ Follow these steps to set up back-in-stock notifications in a specific catalog.
     - **Fallback Catalog** This is the catalog that will be used for the back-in-stock subscription, if there is no `catalog_name` property present on the custom event. 
 
 4. Click **Save** and continue to the catalog's back-in-stock settings page.
-5. Set your notification rule. There are two options: **Notify all subscribed users** and **Notify a certain number of users per a certain number of minutes**. <br>Selecting **Notify all subscribed users** notifies all customers who are waiting when the item is back in stock. **Notify a certain number of users per a certain number of minutes** notifies a specified number of customers per your configured notification period. Braze will notify the specified numbers of customers in increments until there are no more customers to notify, or until the item goes out of stock. Your notification rate cannot exceed notifying 10,000 users per minute.
-6. Set the **Inventory field in catalog** this is the catalog field that will be used to determine if item is out of stock. It must be a Number type field.
+5. Set your notification rule. There are two options:
+    - **Notify all subscribed users** notifies all customers who are waiting when the item is back in stock. 
+    - **Notify a certain number of users per a certain number of minutes** notifies a specified number of customers per your configured notification period. Braze will notify the specified numbers of customers in increments until there are no more customers to notify or until the item goes out of stock. Your notification rate cannot exceed notifying 10,000 users per minute.
+6. Set the **Inventory field in catalog**. This catalog field will be used to determine if the item is out of stock. The field must be number type.
 7. Click **Save settings**.
 
 ![Catalog settings that show the back-in-stock feature turned on. The notification rules are to notify a thousand users every ten minutes.][1]
@@ -45,7 +49,7 @@ Follow these steps to set up back-in-stock notifications in a specific catalog.
 Notification rules in these settings do not replace Canvas notification settings, such as Quiet Hours.
 {% endalert %}
 
-## Using back-in-stock notifications in Canvas
+## Using back-in-stock notifications in a Canvas or campaign
 
 After setting up the back-in-stock feature in a catalog, follow these steps to use with Canvas.
 
@@ -64,4 +68,10 @@ Using ``{{canvas_entry_properties.${catalog_update}}}`` will return the ID of th
 Use this Liquid tag  ``{% catalog_items <name_of_your_catalog> {{canvas_entry_properties.${catalog_update}}} %}`` at the top of your message, then use ``items[0].<field_name>` to access data about that item throughout the message.
 {% endraw %}
 
+## Considerations
+
+- Users are only subscribed for 90 days. If the item isn't back in stock in 90 days, the user is unsubscribed.
+- When using the **Notify all subscribed users** notification rule, Braze will notify 100,000 over 10 minutes.
+- Braze will process at most 10 item updates over one minute. If you update 11 items in one minute, only the first 10 can trigger a back-in-stock notification.
+
 [1]: {% image_buster /assets/img/back_in_stock_settings_non_shopify.png %}