In stock subscriptions
An "in stock" subscription tracks the customer interest for an SKU that has gone out of stock in a given market. When the SKU returns back in stock, all the active subscriptions receive a 'notify' event and you can attach a webhook to actually notify the customer via email or any other channel.
An in stock subscription object is returned as part of the response body of each successful list, retrieve, create or update API call.
Field | Type | Description |
type |
|
|
id |
| The in stock subscription unique identifier |
links.self |
| The in stock subscription endpoint URL |
attributes.status |
| The subscription status. One of 'active' (default), 'inactive', or 'notified' |
attributes.customer_email |
| The email of the associated customer, replace the relationship |
attributes.sku_code |
| The code of the associated sku, replace the relationship |
attributes._activate |
| Send this attribute if you want to activate an inactive subscription. |
attributes._deactivate |
| Send this attribute if you want to dactivate an active subscription. |
attributes.created_at |
| Time at which the resource was created. |
attributes.updated_at |
| Time at which the resource was last updated. |
attributes.reference |
| A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever. |
attributes.reference_origin |
| Any identifier of the third party system that defines the reference code |
attributes.metadata |
| Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format. |
relationships.market |
| The associated market. |
relationships.customer |
| The associated customer. |
relationships.sku |
| The associated sku. |
meta.mode |
| The resource environment (can be one of |
