Order webhooks

We recommend placing an order including a valid webhook URI as part of the order instance. This enables real time updates of the order status.

• The property webhookUri should be set on the order Instance should you wish to use the webhook callbacks.
• Webhooks are responded to using a POST request to the provided URL
• Webhooks are triggered by any status update including those of individual delivery line items, i.e. when a specific delivery respective to an order has shipped.
• Webhooks should accept the JSON content type application/json
• Webhooks send a special x-webhook-shared-token header which is a secret token that can be set by store and used for validation of the webhook
• You should always respond to POST request with a 200 OK status header, the body maybe empty.
• Webhooks have upto 3 delivery times to a valid secure HTTPS url, in case the URL could not be reached or responds incorrectly.
• The body of the webhook contains valid JSON with the following parameters:

{
    id: [string id of orderInstance],
    status: [string status of orderInstance]
}