orders.update

Webhook

POST

orders.update

Triggered when order status changes to one of these statuses:
created, creation_scheduled, preparing, ready, in_transit, completed, canceled, failed.

The payload contains the full Order object with the updated status and all current values.

See stores.update webhook for HTTP request details, delivery guarantees, security, and best practices.

Request

Body Params application/jsonRequired

Example

{
    "client_id": "acme-corp",
    "event_id": "770e8400-e29b-41d4-a716-446655440002",
    "event_type": "orders.update",
    "event_timestamp": 1705349000,
    "api_version": "v1",
    "event_data": {
        "id": 12345,
        "user_phone": "+56912345678",
        "user_email": "customer@example.com",
        "user_address": "123 Main Street, Santiago",
        "user_name": "John Doe",
        "dispatch_method": "store_delivery",
        "store_id": 1,
        "status": "preparing",
        "platform": "web",
        "created_at": "2024-01-15T19:25:00Z",
        "subtotal_price": 25.5,
        "total_price": 31,
        "items": [
            {
                "id": 1,
                "product_id": 101,
                "quantity": 2,
                "name": "Margherita Pizza",
                "price": 12.5
            }
        ],
        "deliveries": [
            {
                "id": 1,
                "type": "own_delivery",
                "status": "confirmed"
            }
        ]
    }
}

Responses

🟢200OK

Webhook received successfully

This response does not have a body.

🔴500Server Error

Modified at 2026-02-17 15:11:07

orders.create

menus.update