Send data to the provided webhook for ORDER callbacks.

post

https://app.swaggerhub.com/your-order-callback-endpoint

The body sent is what you will received as payload.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Global information about the order.

externalId

string

Id mastered by the partner

displayName

string

The name displayed on the iPad in order to distinguish each one

identifier

object

openingInformations

object

All informations about the opening of the order

closingInformations

object | null

The OrderInformation defines an action and all its informations

cancelingInformations

object | null

The OrderInformation defines an action and all its informations

guestNumber

integer

Defaults to 1

The number of guests of the order

location

The id of the location (formerly called table) the order is assigned to

taxInclAmount

integer

Order full, tax included, amount in cents

taxExclAmount

integer | null

Order full, tax included, amount in cents

taxAmount

integer | null

order tax only amount in cents

partnerName

string

name of the partner which created the order originally

comment

string

The comment attached to the order

consumer

deliveryAddress

object

The delivery address for this order

billingAddress

object

The billing address for this order

preparations

array

A preparation is a group of ItemLines, CustomLines and/or PackageItemLines. It define the preparation order of the lines

preparations

itemLines

array

There is 2 types of itemLines, ItemLine which is a line with a product attached to it, coming from the store inventory and CustomLine which is a line without any defined product attached. The main difference between both lines is that CustomLine won't be aggregate together in reports.

itemLines

packageLines

array of objects

List of all packages

packageLines

payments

array of objects

list of all payments registered

payments

discounts

array

list of all discounts applied at the order level. These discount are cumulative. In cents

discounts

Response

200

Success