Order change created
Webhook

Request

Security
SecretApiKey or JWT
Bodyapplication/json
Payload of a webhook event related to an order change.
orderIdstring
ID of the order.
Example:"ord_01HRF27SATGE4Z6PBJE6PD8328"
orderChangeIdstring
ID of the order change.
Example:"ord_chg_0YV7DES3WPC5J8JD8QTVNZBZQ8"
eventTypestring
Type of event that triggered the webhook.
Enum:"order-change-created""order-change-canceled""order-change-applied"
_embeddedobject
Embedded objects related to the order change event.
POST
orders-experimental-order-change-created
Payload
{ "orderId": "ord_01HRF27SATGE4Z6PBJE6PD8328", "orderChangeId": "ord_chg_0YV7DES3WPC5J8JD8QTVNZBZQ8", "eventType": "order-change-created", "_embedded": { "order": { … }, "orderChange": { … } }, "_links": [ { … } ] }

Responses

Returns any 2xx status to indicate that data is received.