When an order is created or modified, a POST request is sent to all configured webhook endpoints, containing the relevant payload in the request body. The webhook is triggered when the following events occur.
- Order is created;
- Order (state) has been modified;
- Articles are accepted via allocation, shipped, returned, refunded or cancelled;
Payload
{
"orderCode": "NC-00001",
"channelCode": "nextchapter-nl",
"isLive": true
}
Explanation of the payload
- orderCode (string): The code of the order.
- channelCode (string): The channel code.
- isLive (bool): The value 'false' refers to the test environment and 'true' to the production environment.
Important: With this information the order related data can be retrieved via the API.