v1
latestOpenAPI 3.1.02026-07-22155403592.5 KBPoint of Sale
Orders
Get orders
Returns a list of the orders
get/consumers/{consumer_id}/pos/orders
Path parameters
consumer_idstring uuid required
Query parameters
pageinteger
Page number
sizeinteger
Page size
date_fromstring date nullable
Start date (inclusive) of the period to get orders from
date_tostring date nullable
End date (inclusive) of the period to get orders from
location_idstring nullable
Unique identifier of the location. If none passed, orders from all locations will be returned unless the location was selected by the end-user
state'open' | 'closed' | 'all'
State of the orders to get
closure_idstring nullable
Unique identifier of the closure. If none passed, orders from all closures will be selected.
Response
Successful Response
Example response
{
"items": [
{
"id": "371ca583-d218-4900-b236-397532cf0e52",
"order_number": "1",
"creation_date": "2025-01-01T00:00:00Z",
"closing_date": "2025-01-01T00:00:00Z",
"service_date": "2025-01-01T00:00:00Z",
"device_id": "device-123",
"total": 11,
"tax_amount": 1,
"total_discount": 10,
"total_refund": 5,
"total_tip": 1,
"delivery_fee": 1,
"currency": "EUR",
"country": "FR",
"loyalty": 100,
"customer_id": "customer-123",
"location_id": "location-123",
"taxes": [
{
"tax_id": "371ca583-d218-4900-b236-397532cf0e39"
}
],
"guests": 1,
"payments": [
{
"id": "payment-123",
"payment_method_id": "payment-method-123",
"payment_method_name": "Cash",
"total": 11,
"tip": 1,
"currency": "EUR",
"date": "2025-01-01T00:00:00Z",
"invoice_ref": "invoice-123"
}
],
"items": [
{
"id": "123",
"menu_id": "456",
"quantity": 1,
"unit_price": 10,
"total": 11,
"tax_amount": 1,
"tax_rate": 10,
"tax_id": "371ca583-d218-4900-b236-397532cf0e39",
"description": "Pizza",
"discounts": [],
"product_id": "789",
"accounting_category_id": "123"
}
]
}
]
}