Introduction

By using the Create API, it's possible to subscribe shoppers to back in stock product alerts or custom topics of your choosing for a shopper.

Endpoint

Authorization

Back In Stock Product Alerts API's follows Basic Authentication. In the Authorization header of your request.

Headers:

Form Data

Example Curl

curl -X POST '{{Swym API Endpoint}}/storeadmin/bispa/subscriptions/create' \
--header 'Accept: application/json' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Basic {{BASE64-ENCODING-OF-"PID:API Key"}}' \
--data-urlencode 'products=[{"epi":37993071378625, "empi":6229447573697, "du":"https://www.demo.swym.it/products/butterfly-sharon-cummings"}]' \
--data-urlencode 'medium=email' \
--data-urlencode '[email protected]'
--data-urlencode 'topics=["backinstock"]'
--data-urlencode 'addtomailinglist=1'

curl -X POST '{{Swym API Endpoint}}/storeadmin/bispa/subscriptions/create' \
--header 'Accept: application/json' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Basic {{BASE64-ENCODING-OF-"PID:API Key"}}' \
--data-urlencode 'products=[{"epi":37993071378625, "empi":6229447573697, "du":"https://www.demo.swym.it/products/butterfly-sharon-cummings"}]' \
--data-urlencode 'medium=email' \
--data-urlencode '[email protected]'
--data-urlencode 'topics=["backinstock","comingsoon"]'
--data-urlencode 'addtomailinglist=1'

🚧

Curl Placeholders

Assuming these values are provided above, the curl command should work correctly. However, if there are any issues with the API endpoint or the data being passed in the request, there could still be errors that need to be resolved before you can test these APIS.

Success Response

The below responses are what you would get based on subscribing to a single topic or for multiple topics.

{
   "message":"Successful",
   "products":[
      {
         "bt":"3M",
         "dt":"3M CGXL-GU General Purpose Extra Large Nitrile Palm Nylon Lining Comfort Grip Glove, Gray",
         "empi":8142224425277,
         "sku":"3MCGXLGU",
         "du":"https://demoswym.myshopify.com/products/3mcgxlgu",
         "pid":"+yFr2xLY3LCQ=",
         "stk":0,
         "epi":44645297750333,
         "iu":"https://cdn.shopify.com/s/files/1/0708/0139/1933/products/3MCGXLGU_620x620.jpg?v=1677090238",
         "uri":"https://demoswym.myshopify.com/products/3mcgxlgu?variant=44645297750333",
         "pr":10.0,
         "vi":""
      }
   ],
   "topics":[
      "backinstock"
   ]
}

{
   "message":"Successful",
   "products":[
      {
         "bt":"3M",
         "dt":"3M CGXL-GU General Purpose Extra Large Nitrile Palm Nylon Lining Comfort Grip Glove, Gray",
         "empi":8142224425277,
         "sku":"3MCGXLGU",
         "du":"https://demoswym.myshopify.com/products/3mcgxlgu",
         "pid":"+yFr2xLY3LCQ=",
         "stk":0,
         "epi":44645297750333,
         "iu":"https://cdn.shopify.com/s/files/1/0708/0139/1933/products/3MCGXLGU_620x620.jpg?v=1677090238",
         "uri":"https://demoswym.myshopify.com/products/3mcgxlgu?variant=44645297750333",
         "pr":10.0,
         "vi":""
      }
   ],
   "topics":[
      "backinstock",
      "comingsoon"
   ]
}

Error Response:

If the request is unsuccessful, the API will return a JSON response with an error message and an HTTP status code indicating the type of error that occurred.

Topic

In Swym's backend, "topics" are specific keywords that define a customer's journey. Each topic has an associated email template and predetermined logic with rules that you can assign and control. These rules can then be used to send emails to the user through the email templates (medium).

Essentially, topics help to streamline the process of sending personalised and relevant emails to customers based on their actions and behaviours on your website.

Here is a sample table to explain some topics used above.

👍

Email Service Provider Support.

We support integration with many third-party Email Service Providers (ESPs) to send alert details. To see the list of supported partners, please visit your Swym Admin Dashboard > Integrations

Other References

Product

To find and subscribe a product on your e-commerce platform, it's necessary to provide the following mandatory information for each item in the array:

Things to Consider

Inventory Updates.

❗️

Inventory must be handled by the platform.

it's necessary for your e-commerce platform, such as Shopify, Bigcommerce, or Magento, to manage your inventory. In other words, if your inventory is not managed by your e-commerce platform, this API will not be compatible with your system

Frontend Stock Checks.

❗️

Ensure Product Availability Before Requesting Subscriptions

Please note that our backend does not pre-stock, pre-quantity check, or pre-validate product topics for subscriptions created from this API. Therefore, it's important to ensure that users can only subscribe to alerts for products that are out of stock or based on topic before making a request.