Webhook Content

In this section you can find webhook content and examples for both types ORDER and MENU

The webhook URL can receive requests by multiple stores and multiple deliveries. When your service receives events, you’ll need to use the external_store_id from the webhook to map it to the right store for notifications and order injections.

For security reason you will receive the request with a custom header parameter that can be use to validate the order.

Header

Value

Signature-Webhook

Hash of the complete request body signed with the secret id registered in the webhook. Hashing algorithm: Sha256

Order contents

JSON body parameters

Order

external_id

string

Id order on the delivery platform

created_at

string

Order creation date on the delivery platform

total

integer

Cost of the entire order (including 2 decimal places)

customer

string

Customer of the order

store_id

string

Id store on the platform

order_number

string

Number order on the delivery platform

instructions

string

Instructions of the order

items

Item[]

All the items contained within the order

discount_value

integer

Order discount value

delivery_id

integer

Id delivery on the platform

Item

external_id

string

Id item on the POS

name

string

Name of the item

quantity

integer

Quantity selected in the order

unit_value

integer

Unit value of the item (including 2 decimal places)

total_unit_value

integer

Unit value of the item + modifiers value (including 2 decimal places)

total_value

integer

Total value of the item + modifiers value (including 2 decimal places)

instructions

string

Instructions of the item

modifiers

Modifier[]

Modifiers selected of the item

Modifier

external_id

string

Id modifier on the POS

name

string

Name of the modifier

quantity

integer

Quantity selected in the order

unit_value

integer

Unit value of the modifier (including 2 decimal places)

total_value

integer

Total value of the modifier (including 2 decimal places)

Example

{
"external_id": "12345678-123-1234-1234-123456789012",
"created_at": "2020-03-20T04:51:03Z",
"total": 25800,
"customer": "Customer Name",
"external_store_id": "3",
"order_number": "ABC12",
"instructions": "",
"items": [
{
"external_id": "13753",
"name": "El Xolo",
"quantity": 2,
"unit_value": 10900,
"total_unit_value": 12900,
"total_value": 25800,
"instructions": "",
"modifiers": [
{
"external_id": "3006",
"name": "Elige Tus Papas",
"quantity": 1,
"unit_value": 0,
"total_value": 0
},
{
"external_id": "3012",
"name": "Elige tu salchicha",
"quantity": 1,
"unit_value": 2000,
"total_value": 2000
}
]
}
],
"discount_value": 800,
"delivery_id": 1
}

You can check the Menu content in the following link Upload menu to delivery app