Skip to main content
GET
/
consumers
/
{consumer_id}
/
pos
/
orders
Get orders
curl --request GET \
  --url https://api.chift.eu/consumers/{consumer_id}/pos/orders \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "id": "<string>",
      "creation_date": "2023-11-07T05:31:56Z",
      "total": 123,
      "tax_amount": 123,
      "payments": [
        {
          "total": 123,
          "id": "payment-123",
          "payment_method_id": "payment-method-123",
          "payment_method_name": "Cash",
          "tip": 1,
          "status": "Completed",
          "currency": "EUR",
          "date": "2025-01-01T00:00:00Z"
        }
      ],
      "items": [
        {
          "id": "<string>",
          "quantity": 123,
          "unit_price": 123,
          "total": 123,
          "tax_amount": 123,
          "type": "product",
          "menu_id": "456",
          "tax_rate": 10,
          "description": "Pizza",
          "discounts": [],
          "product_id": "789",
          "accounting_category_id": "123"
        }
      ],
      "order_number": "1",
      "closing_date": "2025-01-01T00:00:00Z",
      "service_date": "2025-01-01T00:00:00Z",
      "device_id": "device-123",
      "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": [],
      "guests": 1
    }
  ],
  "total": 1,
  "page": 2,
  "size": 2
}

Authorizations

​
Authorization
string
header
required

This access token needs to be included in each of your request to the Chift API.

Path Parameters

​
consumer_id
string<uuid>
required

Query Parameters

​
page
integer
default:1

Page number

Required range: x >= 1
​
size
integer
default:50

Page size

Required range: 1 <= x <= 100
​
date_from
string<date> | null

Start date (inclusive) of the period to get orders from

​
date_to
string<date> | null

End date (inclusive) of the period to get orders from

​
location_id
string | null

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
enum<string>
default:all

State of the orders to get

Available options:
open,
closed,
all
​
closure_id
string | null

Unique identifier of the closure. If none passed, orders from all closures will be selected.

Response

Successful Response

​
items
POSOrderItem · object[]
required
​
total
integer
required
Required range: x >= 0
​
page
integer
required
Required range: x >= 1
​
size
integer
required
Required range: x >= 1