Register Back-in-Stock Request

POST

api

back-in-stock

curl --request POST \
  --url https://api.sequenzy.com/api/v1/back-in-stock \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "productId": "<string>",
  "variantId": "<string>",
  "productTitle": "<string>",
  "variantTitle": "<string>",
  "customer": {}
}
'

import requests

url = "https://api.sequenzy.com/api/v1/back-in-stock"

payload = {
    "productId": "<string>",
    "variantId": "<string>",
    "productTitle": "<string>",
    "variantTitle": "<string>",
    "customer": {}
}
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({
    productId: '<string>',
    variantId: '<string>',
    productTitle: '<string>',
    variantTitle: '<string>',
    customer: {}
  })
};

fetch('https://api.sequenzy.com/api/v1/back-in-stock', 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/back-in-stock",
  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([
    'productId' => '<string>',
    'variantId' => '<string>',
    'productTitle' => '<string>',
    'variantTitle' => '<string>',
    'customer' => [
        
    ]
  ]),
  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/back-in-stock"

	payload := strings.NewReader("{\n  \"productId\": \"<string>\",\n  \"variantId\": \"<string>\",\n  \"productTitle\": \"<string>\",\n  \"variantTitle\": \"<string>\",\n  \"customer\": {}\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/back-in-stock")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"productId\": \"<string>\",\n  \"variantId\": \"<string>\",\n  \"productTitle\": \"<string>\",\n  \"variantTitle\": \"<string>\",\n  \"customer\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sequenzy.com/api/v1/back-in-stock")

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  \"productId\": \"<string>\",\n  \"variantId\": \"<string>\",\n  \"productTitle\": \"<string>\",\n  \"variantTitle\": \"<string>\",\n  \"customer\": {}\n}"

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

{
  "success": true,
  "subscriberId": "sub_abc123"
}

{
  "success": false,
  "error": "Failed to create subscriber"
}

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

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

Register a customer’s request to be notified when a product 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, which can trigger automations. This is the Commerce API equivalent of the Shopify/WooCommerce storefront back-in-stock widgets. Call it from your own storefront or backend when a customer asks to be notified.

Request Body

string

required

Your product identifier (the productId used when upserting products).

string

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

string

Product title snapshot used in notifications. Defaults to the synced product title.

string

Variant title snapshot used in notifications. Defaults to the synced variant title.

object

required

The customer requesting the notification. Requires email; also accepts externalId, firstName, lastName, and attributes. The subscriber is created if they don’t exist.

curl -X POST "https://api.sequenzy.com/api/v1/back-in-stock" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "productId": "SKU-PROTEIN-1KG",
    "variantId": "SKU-PROTEIN-1KG-VANILLA",
    "customer": { "email": "buyer@example.com" }
  }'

What Happens Next

The subscriber is created (if needed) without triggering signup automations
The ecommerce.back_in_stock_requested event is recorded
When a product upsert marks the variant in stock again, the ecommerce.back_in_stock event fires and can start automations

Responses

{
  "success": true,
  "subscriberId": "sub_abc123"
}

{
  "success": false,
  "error": "Failed to create subscriber"
}

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

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

Subscribe to WooCommerce Back-In-StockCapture a WooCommerce storefront back-in-stock request

curl --request POST \
  --url https://api.sequenzy.com/api/v1/back-in-stock \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "productId": "<string>",
  "variantId": "<string>",
  "productTitle": "<string>",
  "variantTitle": "<string>",
  "customer": {}
}
'

import requests

url = "https://api.sequenzy.com/api/v1/back-in-stock"

payload = {
    "productId": "<string>",
    "variantId": "<string>",
    "productTitle": "<string>",
    "variantTitle": "<string>",
    "customer": {}
}
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({
    productId: '<string>',
    variantId: '<string>',
    productTitle: '<string>',
    variantTitle: '<string>',
    customer: {}
  })
};

fetch('https://api.sequenzy.com/api/v1/back-in-stock', 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/back-in-stock",
  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([
    'productId' => '<string>',
    'variantId' => '<string>',
    'productTitle' => '<string>',
    'variantTitle' => '<string>',
    'customer' => [
        
    ]
  ]),
  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/back-in-stock"

	payload := strings.NewReader("{\n  \"productId\": \"<string>\",\n  \"variantId\": \"<string>\",\n  \"productTitle\": \"<string>\",\n  \"variantTitle\": \"<string>\",\n  \"customer\": {}\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/back-in-stock")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"productId\": \"<string>\",\n  \"variantId\": \"<string>\",\n  \"productTitle\": \"<string>\",\n  \"variantTitle\": \"<string>\",\n  \"customer\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sequenzy.com/api/v1/back-in-stock")

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  \"productId\": \"<string>\",\n  \"variantId\": \"<string>\",\n  \"productTitle\": \"<string>\",\n  \"variantTitle\": \"<string>\",\n  \"customer\": {}\n}"

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

{
  "success": true,
  "subscriberId": "sub_abc123"
}

{
  "success": false,
  "error": "Failed to create subscriber"
}

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

{
  "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

Register Back-in-Stock Request

Request Body

What Happens Next

Responses

​Request Body

​What Happens Next

​Responses

Request Body

What Happens Next

Responses