Skip to main content
GET
Get one order

Path Parameters

consumer_id
string<uuid>
required
order_id
string
required

Unique identifier of the order

Response

Successful Response

id
string
required

Unique identifier of the order

Example:

"371ca583-d218-4900-b236-397532cf0e52"

creation_date
string<date-time>
required

Creation date of the order

Example:

"2025-01-01T00:00:00Z"

total
number
required

Total amount including tax of the order

Example:

11

tax_amount
number
required

Total amount of the taxes of the order

Example:

1

payments
POSPaymentItem · object[]
required

List of payments made for the order

items
POSItem · object[]
required

List of item lines in the order

order_number
string | null

Order number (often unique reference during the day)

Example:

"1"

closing_date
string<date-time> | null

Closing date of the order

Example:

"2025-01-01T00:00:00Z"

service_date
string<date-time> | null

Indicates the date of the service to which the order belongs (can be used to group orders by closure date)

Example:

"2025-01-01T00:00:00Z"

device_id
string | null

ID of device that created the order

Example:

"device-123"

total_discount
number | null
default:0

Total amount of the discounts of the order

Example:

10

total_refund
number | null
default:0

Total amount of the refunds of the order

Example:

5

total_tip
number | null
default:0

Total amount of the tips of the order. Tips are not part of the total of the order

Example:

1

delivery_fee
number | null
default:0

Total amount of the delivery fees of the order

Example:

1

mode
enum<string> | null
default:UNKNOWN

Delivery Mode

Available options:
EAT_IN,
TAKEAWAY,
DELIVERY,
UNKNOWN
Example:

"eat_in"

source
enum<string> | null
default:UNKNOWN

Source of the order

Available options:
WEB,
MOBILE,
KIOSK,
POS,
REMOTE_POS,
JUSTEAT,
FOODORA,
UBEREATS,
GLOVO,
DELIVEROO,
SMILEIN,
UNKNOWN
Example:

"web"

currency
string | null

Currency of the order

Example:

"EUR"

country
string | null

Country of the order, format: ISO 3166-1 codes.

Example:

"FR"

loyalty
integer | null

Loyalty points of the order

Example:

100

customer_id
string | null

Unique identifier of the customer

Example:

"customer-123"

location_id
string | null

Unique identifier of the location

Example:

"location-123"

taxes
TotalTaxItem · object[] | null

List of taxes of the order

guests
integer | null

Number of guests linked to the order

Example:

1