Skip to main content
WEBHOOK
product.update
{
  "product_code": "XYZ-US",
  "old_state": {
    "price_multiplier": "0.05",
    "is_orderable": true,
    "denominations": {
      "type": "fixed",
      "minimum_value": "10.00",
      "maximum_value": "100.00",
      "available_list": [
        "10.00",
        "20.00",
        "50.00",
        "100.00"
      ]
    }
  },
  "new_state": {
    "price_multiplier": "0.05",
    "is_orderable": true,
    "denominations": {
      "type": "fixed",
      "minimum_value": "10.00",
      "maximum_value": "100.00",
      "available_list": [
        "10.00",
        "20.00",
        "50.00",
        "100.00"
      ]
    }
  },
  "timestamp": "2023-11-07T05:31:56Z"
}

How to implement real-time product updates

Webhooks work differently to the API endpoints. Take a read of our guide to implement real-time product updates in your system.
 An event is triggered when there is an update to a product in the catalog. If multiple products are updated at once, an event is triggered for each product. Use the product_code to identify the product that was updated, then refer to the old_state and new_state to determine the changes. A timestamp is provided to indicate when the update occurred.
Due to the nature of webhooks you should not rely on the order of the events. You should store the timestamp and discard any events that are older than the last event you received.

Authorizations

​
X-Api-Key
string
header
required

Your API key. See the API key page on details of how to generate and store your keys.

Body

application/json

Update on product status

​
product_code
string
required

The code of the product that was updated.

Example:

"XYZ-US"

​
old_state
Product update state · object
required

The state of the product before the update.

​
new_state
Product update state · object
required

The state of the product after the update.

​
timestamp
string<date-time>
required

UTC timestamp, in ISO 8601 format, when the product was updated.

Response

200

Return a 200 status to indicate that the data was received successfully