Sign in

v97

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-04231129815.9 KB
Products

Register back-in-stock request

Registers a customer's request to be notified when a product (pushed via the Commerce API) is back in stock. When a later product upsert marks the product or variant in stock again, the ecommerce.back_in_stock event fires for waiting subscribers.

post/back-in-stock

Request body

productIdstring required

Your product identifier

variantIdstring

Your variant identifier. Defaults to productId for products without variants.

productTitlestring

Product title snapshot. Defaults to the synced product title.

variantTitlestring

Variant title snapshot. Defaults to the synced variant title.

Example request

{
  "productId": "SKU-PROTEIN-1KG",
  "variantId": "SKU-PROTEIN-1KG-VANILLA",
  "customer": {
    "email": "buyer@example.com",
    "externalId": "user_123",
    "firstName": "Jane",
    "lastName": "Doe",
    "attributes": {
      "acquisitionChannel": "tiktok",
      "country": "US"
    }
  }
}

Response

Back-in-stock request registered

successboolean
subscriberIdstring

Example response

{
  "success": true
}