{
"type": "order.completed",
"timestamp": "2024-01-03T14:25:07Z",
"data": {
"id": "O-01H5WQGHKCBB85MQFM68S9KJ5Q",
"status": "PROCESSING",
"created_at": "2023-11-07T05:31:56Z",
"payment_method": {
"type": "ACCOUNT_BALANCE",
"currency": "USD"
},
"currency": "USD",
"total_price": "10.00",
"total_discount": "1.00",
"completed_at": "2023-11-07T05:31:56Z",
"description": "Your own reference text"
}
}Order completed
Order completed events are triggered when an order completes.
WEBHOOK
order.completed
{
"type": "order.completed",
"timestamp": "2024-01-03T14:25:07Z",
"data": {
"id": "O-01H5WQGHKCBB85MQFM68S9KJ5Q",
"status": "PROCESSING",
"created_at": "2023-11-07T05:31:56Z",
"payment_method": {
"type": "ACCOUNT_BALANCE",
"currency": "USD"
},
"currency": "USD",
"total_price": "10.00",
"total_discount": "1.00",
"completed_at": "2023-11-07T05:31:56Z",
"description": "Your own reference text"
}
}Webhook overview
Webhooks work differently to the API endpoints. Take a read of our guide to
understand how they work.
order.failed, it replaces order.completion.
The order is in data, in the same shape as the completed order.completion payload.Body
application/json
The completed order
Standard Webhooks envelope sent when an order completes. The order is in data.
Always order.completed for this event.
Allowed value:
"order.completed"When the order completed (RFC 3339, UTC).
Example:
"2024-01-03T14:25:07Z"
Webhook message sent when an order has completed processing.
Show child attributes
Show child attributes
Response
200
Return a 200 status to indicate that the data was received successfully
Was this page helpful?