Product State Change

Register Product State Change URL

Overview

The /customer/notification/product-state endpoint can be utilised to register your webhook URL for the product state changes.

Each time a product in your catalog gets its state changed, the URL which you provide in this request will be called. The endpoint you specify should be open and should accept POST requests.

HTTP Request

POST /customer/notification/product-state

Content-Type

application/json

Request Body

Field

Type

Description

url

string | null

Either a url string or null for unsetting the webhook calls.

Sample Request Body

{
    "url": "https://youservice.com/webhooks/product-state-changed"
}

Product State Change Webhook

The endpoint you specified in the previous step will receive a POST call:

Request body structure

Verification additional data field: N/A

{
  "sku": string, // The sku of the changed product
  "state": string, // The new state of the sku, either "ACTIVE" or "INACTIVE"
  "quote": number | null, // For time & custom_fixed products. If state is ACTIVE it's always populated.
}

Verifying Order Webhook Requests

Follow the instructions mentioned here.

Last updated