Manage availability notifications

Last updated:
Edit on GitHub

Availability Notification allows registered and guest customers to subscribe to availability notifications for an unavailable product so that when the product is back in stock, they could receive a notification.

This endpoint allows managing availability notifications of registered and guest customers.

Installation

For detailed information on the modules that provide the API functionality and related installation instructions, see Install the Availability Notification Glue API.

Subscribe to availability notifications

To subscribe to availability notifications for an out-of-stock product, send the request:

POST /availability-notifications

Request

Request sample: subscribe to availability notifications

POST https://glue.mysprykershop.com/availability-notifications

{
  "data": {
    "type": "availability-notifications",
    "attributes": {
      "sku": "130_24725761",
      "email": "sonia@spryker.com"
    }
  }
}
ATTRIBUTE TYPE REQUIRED DESCRIPTION
sku string ✓ SKU of a product to subscribe the customer to.
email string ✓ Customer email where product availability notifications will be sent to.

Response

Response sample: subscribe to availability notifications 
{
    "data": {
        "type": "availability-notifications",
        "id": "70b47ccf1e1a2262f83fddabd19d4828",
        "attributes": {
            "localeName": "en_US",
            "email": "sonia@spryker.com",
            "sku": "130_24725761"
        },
        "links": {
            "self": "https://glue.mysprykershop.com/availability-notifications/70b47ccf1e1a2262f83fddabd19d4828"
        }
    }
}
ATTRIBUTE TYPE DESCRIPTION
localeName string Locale of the subscribed customer.
email string Customer email where the product availability notifications are sent to.
sku string SKU of the product the customer receives notifications about.

Unsubscribe from availability notifications

To unsubscribe from availability notifications for a product, send the request:

DELETE /availability-notifications/{{subscriptionKey}}

PATH PARAMETER DESCRIPTION
{{subscriptionKey}} Subscription id that is assigned when the subscription is created. To get it as an id attribute, subscribe to product availability email notifications or retrieve existing subscriptions. Exampe: "id": "d634981b8d1930f7db6e2780b7d5600a".
Note that anyone who has a subscription id can delete the subscription the id is assigned to.

Request

Request sample: unsubscribe from availability notifications

DELETE https://glue.mysprykershop.com/availability-notifications/05f2004950e01a056537384a405ec9a0

Response

If a customer’s subscription is deleted successfully, the endpoint returns the 204 No Content status code.

CODE REASON
001 Access token is invalid.
002 Access token is missing.
901 SKU or email is not provided; email is invalid.
4601 Product is not found.
4602 Subscription already exists.
4603 Subscription doesn’t exist.
4606 Request is not authorized.

To view generic errors that originate from the Glue Application, see Reference information: GlueApplication errors.