API Reference Overview
Authentication
Consumers
Connections
Accounting
- Folders
- Book years
- Clients
- Suppliers
- Invoices
- Ledger accounts
- Journals
- Journal entries
- Employees
- Analytic plans
- Analytic accounts
- Miscellaneous operations
- Outstandings
Invoicing
- Contacts
- Invoices
- Products
- Taxes
- Opportunities
- Payments
- Payment methods
POS
- Orders
- Payment methods
- Payments
- Closure info
- Locations
- Products
- Categories
- Customers
eCommerce
- Orders
- Products & variants
- Categories
- Customers
- Payment methods
- Locations
- Countries
- Taxes
PMS
- Orders
- Invoices
- Payment methods
- Payments
- Closure info
- Locations
- Categories
- Customers
Payment
- Payments
- Balances
- Transactions
- Refunds
Banking
- Financial institutions
- Banking accounts
- Transactions
Advanced
- Webhooks
- Syncs
- Issues
- Datastores
Get orders (PMS)
Returns a list of the orders
curl --request GET \
--url https://api.chift.eu/consumers/{consumer_id}/pms/orders \
--header 'Authorization: Bearer <token>'
{
"items": [
{
"id": "123",
"source_ref": {
"id": "<string>",
"model": "<string>"
},
"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": [],
"guests": 1,
"items": [
{
"id": "123",
"source_ref": {
"id": "<string>",
"model": "<string>"
},
"type": "product",
"menu_id": "456",
"quantity": 1,
"unit_price": 10,
"total": 11,
"tax_amount": 1,
"tax_rate": 10,
"description": "Pizza",
"discounts": [],
"product_id": "789",
"accounting_category_id": "123"
}
],
"service_id": "<string>",
"reservation": {
"id": "<string>",
"source_ref": {
"id": "<string>",
"model": "<string>"
},
"start_date": "2023-11-07T05:31:56Z",
"end_date": "2023-11-07T05:31:56Z",
"creation_date": "2023-11-07T05:31:56Z",
"resource_id": {
"id": "<string>",
"source_ref": {
"id": "<string>",
"model": "<string>"
}
},
"resource_name": "<string>",
"resource_identifier": "<string>"
},
"bills": [
{
"id": "<string>",
"source_ref": {
"id": "<string>",
"model": "<string>"
},
"invoice_number": "<string>",
"creation_date": "2023-11-07T05:31:56Z",
"closing_date": "2023-11-07T05:31:56Z",
"partners": [
{
"id": "<string>",
"source_ref": {
"id": "<string>",
"model": "<string>"
},
"type": "owner",
"address": {
"address_type": "home",
"name": "Home",
"street": "Main Street",
"number": "123",
"box": "A",
"city": "Paris",
"postal_code": "75000",
"country": "FR"
},
"first_name": "<string>",
"last_name": "<string>",
"company_name": "<string>"
}
]
}
]
}
],
"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
x >= 1
1 <= x <= 100
An enumeration.
consumed
, closed
Response
Unique identifier of the order
"123"
Creation date of the order
"2025-01-01T00:00:00Z"
Total amount including tax of the order
11
Total amount of the taxes of the order
1
List of items related to the order
Unique identifier of the order line item
"123"
Quantity of the order line item
1
Unit price (without tax) of the order line item
10
Total amount including tax of the order line item
11
Total amount of the taxes of the order line item
1
Type of the order line item
menu
, product
"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
Reference to the service related to this order
Reference to the reservation related to this order
Technical id in Chift
Start date of the reservation
End date of the reservation
Creation date of the reservation
Uniuqe reference to the resource related to the reservation
Technical id in Chift
Name of the resource related to the reservation
Identifier of the resource related to the reservation
Reference to the bills related to this order
Technical id in Chift
Number/sequence
Creation date of the invoice
Closing date of the invoice
List of partners related to the invoice
Technical id in Chift
Type of the partner
owner
, account
Address of the partner
Type of the address
"home"
Name given to the address (e.g. 'home')
"Home"
Street name
"Main Street"
Number of the address
"123"
Box of the address
"A"
City name
"Paris"
Postal code of the address
"75000"
Country, format: ISO 3166-1 codes.
"FR"
First name of the partner. In case the partner is an individual.
Last name of the partner. In case the partner is an individual.
Company name of the partner. In case the partner is a company.
x >= 0
x >= 1
x >= 1
curl --request GET \
--url https://api.chift.eu/consumers/{consumer_id}/pms/orders \
--header 'Authorization: Bearer <token>'
{
"items": [
{
"id": "123",
"source_ref": {
"id": "<string>",
"model": "<string>"
},
"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": [],
"guests": 1,
"items": [
{
"id": "123",
"source_ref": {
"id": "<string>",
"model": "<string>"
},
"type": "product",
"menu_id": "456",
"quantity": 1,
"unit_price": 10,
"total": 11,
"tax_amount": 1,
"tax_rate": 10,
"description": "Pizza",
"discounts": [],
"product_id": "789",
"accounting_category_id": "123"
}
],
"service_id": "<string>",
"reservation": {
"id": "<string>",
"source_ref": {
"id": "<string>",
"model": "<string>"
},
"start_date": "2023-11-07T05:31:56Z",
"end_date": "2023-11-07T05:31:56Z",
"creation_date": "2023-11-07T05:31:56Z",
"resource_id": {
"id": "<string>",
"source_ref": {
"id": "<string>",
"model": "<string>"
}
},
"resource_name": "<string>",
"resource_identifier": "<string>"
},
"bills": [
{
"id": "<string>",
"source_ref": {
"id": "<string>",
"model": "<string>"
},
"invoice_number": "<string>",
"creation_date": "2023-11-07T05:31:56Z",
"closing_date": "2023-11-07T05:31:56Z",
"partners": [
{
"id": "<string>",
"source_ref": {
"id": "<string>",
"model": "<string>"
},
"type": "owner",
"address": {
"address_type": "home",
"name": "Home",
"street": "Main Street",
"number": "123",
"box": "A",
"city": "Paris",
"postal_code": "75000",
"country": "FR"
},
"first_name": "<string>",
"last_name": "<string>",
"company_name": "<string>"
}
]
}
]
}
],
"total": 1,
"page": 2,
"size": 2
}