Order completion
Order completion events are triggered when an order has completed processing.
Webhook overview
Webhooks work differently to the API endpoints. Take a read of our guide to understand how they work.
This event is essential when using the async ordering mode if you need to take action when an order has completed processing. It’s also useful if you want to feed ordering data into your system.
The webhook payload depends on whether the order was processed successfully or not. You should use the status
field to determine the type of payload you have received.
- Successfully completed orders will have a
status
ofCOMPLETED
- Failed orders will have a
status
ofFAILED
Body
Sent when an order finishes processing, the body object will be one of the following schemas depending on the order status.
Webhook message sent when an order has completed processing. Used for orders that have completed. This class is typically used when returning a list of orders to the client.
Webhook message sent when an order has completed processing. Used for orders that have completed. This class is typically used when returning a list of orders to the client.
Webhook message sent when an order has failed to process.
Response
Return a 200 status to indicate that the data was received successfully