API Reference Overview
Access & Connections
Accounting
Invoicing
eCommerce
PMS
Payment
Banking
Other
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
}Get orders
Returns a list of the 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
This access token needs to be included in each of your request to the Chift API.
Path Parameters
Query Parameters
Page number
x >= 1Page size
1 <= x <= 100Start date (inclusive) of the period to get orders from
End date (inclusive) of the period to get orders from
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 of the orders to get
open, closed, all Unique identifier of the closure. If none passed, orders from all closures will be selected.
Response
Successful Response
Show child attributes
Show child attributes
Unique identifier of the order
Creation date of the order
Total amount including tax of the order
Total amount of the taxes of the order
List of payments made for the order
Show child attributes
Show child attributes
Total amount of the payment
Unique identifier of the payment
"payment-123"
Unique identifier of the payment method used for the payment
"payment-method-123"
Chift's name of the payment method used for the payment
"Cash"
Total amount of the tips of the payment. Tips are not part of the total of the payment
1
Status of the payment
Pending, Completed, Canceled, Failed, Unknown, Authorised "Completed"
Currency of the payment
"EUR"
Date of the payment
"2025-01-01T00:00:00Z"
List of item lines in the order
Show child attributes
Show child attributes
Unique identifier of the order line item
Quantity of the order line item
Unit price (without tax) of the order line item
Total amount including tax of the order line item
Total amount of the taxes of the order line item
Type of the order line item
menu, product, service, general_discount "product"
Unique identifier of the menu
"456"
Tax rate of the order line item
10
Description of the order line item
"Pizza"
List of discounts of the order line item. Discounts of items are always part of the total discount of the order
[]Reference to the product related to this item
"789"
Sometimes used by a POS to give a specific accounting category to an order item
"123"
Order number (often unique reference during the day)
"1"
Closing date of the order
"2025-01-01T00:00:00Z"
Indicates the date of the service to which the order belongs (can be used to group orders by closure date)
"2025-01-01T00:00:00Z"
ID of device that created the order
"device-123"
Total amount of the discounts of the order
10
Total amount of the refunds of the order
5
Total amount of the tips of the order. Tips are not part of the total of the order
1
Total amount of the delivery fees of the order
1
Currency of the order
"EUR"
Country of the order, format: ISO 3166-1 codes.
"FR"
Loyalty points of the order
100
Unique identifier of the customer
"customer-123"
Unique identifier of the location
"location-123"
Number of guests linked to the order
1
x >= 0x >= 1x >= 1