v93

OpenAPI 3.1.0raw.githubusercontent.com2026-08-01218121759.7 KB
Products

Upsert products

Creates or updates up to 100 products, keyed by your productId. Products pushed here behave like Shopify/WooCommerce products - they power product blocks, replenishment reminders, and back-in-stock notifications. Stock transitions trigger back-in-stock events for waiting subscribers. Updates are partial - omitted optional fields keep their stored values; pass an explicit null to clear one.

post/products

Request body

Example request

{
  "products": [
    {
      "productId": "SKU-PROTEIN-1KG",
      "title": "Protein Powder",
      "description": "Whey protein, 1kg bag",
      "imageUrl": "https://cdn.example.com/protein.jpg",
      "url": "https://store.example.com/products/protein",
      "priceCents": 8850,
      "compareAtPriceCents": 9900,
      "currency": "USD",
      "variants": [
        {
          "variantId": "SKU-PROTEIN-1KG-VANILLA",
          "title": "Vanilla",
          "options": [
            {
              "name": "Flavor",
              "value": "Vanilla"
            }
          ]
        }
      ]
    }
  ]
}

Response

Products upserted successfully

successboolean
upsertedinteger
backInStockEventsTriggeredinteger

Number of back-in-stock notifications triggered by stock transitions in this upsert

Example response

{
  "success": true,
  "upserted": 1,
  "products": [
    {
      "productId": "SKU-PROTEIN-1KG",
      "providerProductId": "prod_ABC123",
      "provider": "api",
      "title": "Protein Powder",
      "price": 8850,
      "priceCents": 8850,
      "currency": "USD",
      "digitalDelivery": {
        "url": "https://images.sequenzy.com/product-files/comp_123/9f2.../guide.pdf",
        "fileName": "guide.pdf",
        "mimeType": "application/pdf"
      }
    }
  ]
}