Upsert Products

POST

api

products

Upsert Products

curl --request POST \
  --url https://api.sequenzy.com/api/v1/products \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "products": [
    {}
  ],
  "products[].productId": "<string>",
  "products[].title": "<string>",
  "products[].description": "<string>",
  "products[].imageUrl": "<string>",
  "products[].url": "<string>",
  "products[].priceCents": 123,
  "products[].compareAtPriceCents": 123,
  "products[].currency": "<string>",
  "products[].inStock": true,
  "products[].variants": [
    {}
  ]
}
'

import requests

url = "https://api.sequenzy.com/api/v1/products"

payload = {
    "products": [{}],
    "products[].productId": "<string>",
    "products[].title": "<string>",
    "products[].description": "<string>",
    "products[].imageUrl": "<string>",
    "products[].url": "<string>",
    "products[].priceCents": 123,
    "products[].compareAtPriceCents": 123,
    "products[].currency": "<string>",
    "products[].inStock": True,
    "products[].variants": [{}]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    products: [{}],
    'products[].productId': '<string>',
    'products[].title': '<string>',
    'products[].description': '<string>',
    'products[].imageUrl': '<string>',
    'products[].url': '<string>',
    'products[].priceCents': 123,
    'products[].compareAtPriceCents': 123,
    'products[].currency': '<string>',
    'products[].inStock': true,
    'products[].variants': [{}]
  })
};

fetch('https://api.sequenzy.com/api/v1/products', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sequenzy.com/api/v1/products",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'products' => [
        [
                
        ]
    ],
    'products[].productId' => '<string>',
    'products[].title' => '<string>',
    'products[].description' => '<string>',
    'products[].imageUrl' => '<string>',
    'products[].url' => '<string>',
    'products[].priceCents' => 123,
    'products[].compareAtPriceCents' => 123,
    'products[].currency' => '<string>',
    'products[].inStock' => true,
    'products[].variants' => [
        [
                
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sequenzy.com/api/v1/products"

	payload := strings.NewReader("{\n  \"products\": [\n    {}\n  ],\n  \"products[].productId\": \"<string>\",\n  \"products[].title\": \"<string>\",\n  \"products[].description\": \"<string>\",\n  \"products[].imageUrl\": \"<string>\",\n  \"products[].url\": \"<string>\",\n  \"products[].priceCents\": 123,\n  \"products[].compareAtPriceCents\": 123,\n  \"products[].currency\": \"<string>\",\n  \"products[].inStock\": true,\n  \"products[].variants\": [\n    {}\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.sequenzy.com/api/v1/products")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"products\": [\n    {}\n  ],\n  \"products[].productId\": \"<string>\",\n  \"products[].title\": \"<string>\",\n  \"products[].description\": \"<string>\",\n  \"products[].imageUrl\": \"<string>\",\n  \"products[].url\": \"<string>\",\n  \"products[].priceCents\": 123,\n  \"products[].compareAtPriceCents\": 123,\n  \"products[].currency\": \"<string>\",\n  \"products[].inStock\": true,\n  \"products[].variants\": [\n    {}\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sequenzy.com/api/v1/products")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"products\": [\n    {}\n  ],\n  \"products[].productId\": \"<string>\",\n  \"products[].title\": \"<string>\",\n  \"products[].description\": \"<string>\",\n  \"products[].imageUrl\": \"<string>\",\n  \"products[].url\": \"<string>\",\n  \"products[].priceCents\": 123,\n  \"products[].compareAtPriceCents\": 123,\n  \"products[].currency\": \"<string>\",\n  \"products[].inStock\": true,\n  \"products[].variants\": [\n    {}\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "upserted": 1,
  "backInStockEventsTriggered": 0,
  "products": [
    {
      "id": "prod_abc123",
      "productId": "SKU-PROTEIN-1KG",
      "provider": "api",
      "title": "Protein Powder",
      "priceCents": 8850,
      "currency": "USD",
      "inStock": true,
      "variants": [
        {
          "variantId": "SKU-PROTEIN-1KG-VANILLA",
          "title": "Vanilla",
          "priceCents": 8850,
          "inStock": true,
          "inventoryQuantity": 12
        }
      ]
    }
  ]
}

{
  "success": false,
  "error": "Unauthorized"
}

{
  "success": false,
  "error": "Validation error: products is required"
}

{
  "success": false,
  "error": "Internal server error"
}

Create or update up to 100 products in your Sequenzy catalog, keyed by your productId. Products pushed here behave exactly like products synced from Shopify or WooCommerce - they power product blocks in emails, replenishment reminders, back-in-stock notifications, and segmentation. Use this endpoint to connect any e-commerce platform (custom checkout, CheckoutChamp, Sticky.io, your own backend) to Sequenzy. See the custom commerce integration guide for the full walkthrough. Updates are partial: optional fields you omit keep their stored values, so a stock-only update like {"productId": "SKU-1", "title": "...", "inStock": false} does not erase the product’s image, URL, or pricing. Pass an explicit null to clear a stored value.

Request Body

array

required

Products to create or update (1-100 per request). Each product is upserted by its productId.

string

required

Your product identifier. Used as the upsert key - pushing the same productId again updates the product.

string

required

Product title.

string

Product description.

string

Product image URL.

string

Public product page URL. Used for links in emails.

integer

Price in cents. Defaults to the lowest variant price when variants are provided.

integer

Compare-at (strikethrough) price in cents.

string

ISO 4217 currency code (e.g. USD).

boolean

Whether the product is in stock. Defaults to true, or to whether any variant is available when variants are provided.

array

Product variants. Each variant has variantId (required), title (required), sku, priceCents, compareAtPriceCents, imageUrl, inStock, inventoryQuantity, and options (array of { name, value }). When provided, the variant list is replaced entirely - pass an empty array to remove all variants. Omit the field to leave existing variants unchanged.

curl -X POST "https://api.sequenzy.com/api/v1/products" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "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",
        "currency": "USD",
        "variants": [
          {
            "variantId": "SKU-PROTEIN-1KG-VANILLA",
            "title": "Vanilla",
            "priceCents": 8850,
            "inventoryQuantity": 12,
            "options": [{ "name": "Flavor", "value": "Vanilla" }]
          },
          {
            "variantId": "SKU-PROTEIN-1KG-CHOC",
            "title": "Chocolate",
            "priceCents": 8850,
            "inStock": false,
            "options": [{ "name": "Flavor", "value": "Chocolate" }]
          }
        ]
      }
    ]
  }'

Stock Transitions

When an upsert changes a product or variant from out of stock to in stock, Sequenzy automatically fires the ecommerce.back_in_stock event for subscribers who requested a back-in-stock notification. Going out of stock cancels pending notifications. Replenishment settings configured in the dashboard are preserved across upserts.

Responses

{
  "success": true,
  "upserted": 1,
  "backInStockEventsTriggered": 0,
  "products": [
    {
      "id": "prod_abc123",
      "productId": "SKU-PROTEIN-1KG",
      "provider": "api",
      "title": "Protein Powder",
      "priceCents": 8850,
      "currency": "USD",
      "inStock": true,
      "variants": [
        {
          "variantId": "SKU-PROTEIN-1KG-VANILLA",
          "title": "Vanilla",
          "priceCents": 8850,
          "inStock": true,
          "inventoryQuantity": 12
        }
      ]
    }
  ]
}

{
  "success": false,
  "error": "Unauthorized"
}

{
  "success": false,
  "error": "Validation error: products is required"
}

{
  "success": false,
  "error": "Internal server error"
}

List ProductsList products in your catalog

Upsert Products

curl --request POST \
  --url https://api.sequenzy.com/api/v1/products \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "products": [
    {}
  ],
  "products[].productId": "<string>",
  "products[].title": "<string>",
  "products[].description": "<string>",
  "products[].imageUrl": "<string>",
  "products[].url": "<string>",
  "products[].priceCents": 123,
  "products[].compareAtPriceCents": 123,
  "products[].currency": "<string>",
  "products[].inStock": true,
  "products[].variants": [
    {}
  ]
}
'

import requests

url = "https://api.sequenzy.com/api/v1/products"

payload = {
    "products": [{}],
    "products[].productId": "<string>",
    "products[].title": "<string>",
    "products[].description": "<string>",
    "products[].imageUrl": "<string>",
    "products[].url": "<string>",
    "products[].priceCents": 123,
    "products[].compareAtPriceCents": 123,
    "products[].currency": "<string>",
    "products[].inStock": True,
    "products[].variants": [{}]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    products: [{}],
    'products[].productId': '<string>',
    'products[].title': '<string>',
    'products[].description': '<string>',
    'products[].imageUrl': '<string>',
    'products[].url': '<string>',
    'products[].priceCents': 123,
    'products[].compareAtPriceCents': 123,
    'products[].currency': '<string>',
    'products[].inStock': true,
    'products[].variants': [{}]
  })
};

fetch('https://api.sequenzy.com/api/v1/products', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sequenzy.com/api/v1/products",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'products' => [
        [
                
        ]
    ],
    'products[].productId' => '<string>',
    'products[].title' => '<string>',
    'products[].description' => '<string>',
    'products[].imageUrl' => '<string>',
    'products[].url' => '<string>',
    'products[].priceCents' => 123,
    'products[].compareAtPriceCents' => 123,
    'products[].currency' => '<string>',
    'products[].inStock' => true,
    'products[].variants' => [
        [
                
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sequenzy.com/api/v1/products"

	payload := strings.NewReader("{\n  \"products\": [\n    {}\n  ],\n  \"products[].productId\": \"<string>\",\n  \"products[].title\": \"<string>\",\n  \"products[].description\": \"<string>\",\n  \"products[].imageUrl\": \"<string>\",\n  \"products[].url\": \"<string>\",\n  \"products[].priceCents\": 123,\n  \"products[].compareAtPriceCents\": 123,\n  \"products[].currency\": \"<string>\",\n  \"products[].inStock\": true,\n  \"products[].variants\": [\n    {}\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.sequenzy.com/api/v1/products")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"products\": [\n    {}\n  ],\n  \"products[].productId\": \"<string>\",\n  \"products[].title\": \"<string>\",\n  \"products[].description\": \"<string>\",\n  \"products[].imageUrl\": \"<string>\",\n  \"products[].url\": \"<string>\",\n  \"products[].priceCents\": 123,\n  \"products[].compareAtPriceCents\": 123,\n  \"products[].currency\": \"<string>\",\n  \"products[].inStock\": true,\n  \"products[].variants\": [\n    {}\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sequenzy.com/api/v1/products")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"products\": [\n    {}\n  ],\n  \"products[].productId\": \"<string>\",\n  \"products[].title\": \"<string>\",\n  \"products[].description\": \"<string>\",\n  \"products[].imageUrl\": \"<string>\",\n  \"products[].url\": \"<string>\",\n  \"products[].priceCents\": 123,\n  \"products[].compareAtPriceCents\": 123,\n  \"products[].currency\": \"<string>\",\n  \"products[].inStock\": true,\n  \"products[].variants\": [\n    {}\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "upserted": 1,
  "backInStockEventsTriggered": 0,
  "products": [
    {
      "id": "prod_abc123",
      "productId": "SKU-PROTEIN-1KG",
      "provider": "api",
      "title": "Protein Powder",
      "priceCents": 8850,
      "currency": "USD",
      "inStock": true,
      "variants": [
        {
          "variantId": "SKU-PROTEIN-1KG-VANILLA",
          "title": "Vanilla",
          "priceCents": 8850,
          "inStock": true,
          "inventoryQuantity": 12
        }
      ]
    }
  ]
}

{
  "success": false,
  "error": "Unauthorized"
}

{
  "success": false,
  "error": "Validation error: products is required"
}

{
  "success": false,
  "error": "Internal server error"
}

Overview

Companies

Sync Rules

Shopify

Websites

Integrations

Sender Profiles

Tracking Settings

Subscribers

Tags

Lists

Events

Segments

Audience Syncs

Migrations

Products

Media

Analytics

Sequences

Generation

SMS

Campaigns

Landing Pages

Emails

A/B Tests

Email Sends

Suppressions

Transactional

Templates

Widgets

Commerce

Webhooks

Team

Conversations

Request Body

Stock Transitions

Responses

​Request Body

​Stock Transitions

​Responses

Request Body

Stock Transitions

Responses