Get orders (PMS)

API Reference Overview

Overview

Authentication

POST
Get access token

Consumers

Connections

Integrations

Accounting

Folders
Book years
Clients
Suppliers
Invoices
Ledger accounts
Journals
Journal entries
Employees
Analytic plans
Analytic accounts
Miscellaneous operations
Outstandings
VAT codes

Invoicing

Contacts
Invoices
Products
Taxes
Opportunities
Payments
Payment methods

POS

Orders
Payment methods
Payments
Closure info
Locations
Products
Categories
Customers
Objectives

eCommerce

Orders
Products & variants
Categories
Customers
Payment methods
Locations
Countries
Taxes

PMS

Orders
- GET
  Get orders (PMS)
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

consumers

{consumer_id}

pms

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

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

required

Query Parameters

page

integer

default:1

Required range: x >= 1

size

integer

default:50

Required range: 1 <= x <= 100

date_from

string

required

date_to

string

required

location_id

string

state

enum<string>

default:consumed

An enumeration.

Available options:

consumed,

closed

Response

200

application/json

Successful Response

items

object[]

required

items.id

string

required

Unique identifier of the order

Example:

"123"

items.source_ref

object

required

Technical id in the target software

items.creation_date

string

required

Creation date of the order

Example:

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

items.total

number

required

Total amount including tax of the order

Example:

11

items.tax_amount

number

required

Total amount of the taxes of the order

Example:

1

items.items

object[]

required

List of items related to the order

items.items.id

string

required

Unique identifier of the order line item

Example:

"123"

items.items.source_ref

object

required

Technical id in the target software

items.items.quantity

number

required

Quantity of the order line item

Example:

1

items.items.unit_price

number

required

Unit price (without tax) of the order line item

Example:

10

items.items.total

number

required

Total amount including tax of the order line item

Example:

11

items.items.tax_amount

number

required

Total amount of the taxes of the order line item

Example:

1

items.items.type

enum<string>

Type of the order line item

Available options:

menu,

product

Example:

"product"

Unique identifier of the menu

Example:

"456"

items.items.tax_rate

number

Tax rate of the order line item

Example:

10

items.items.description

string

Description of the order line item

Example:

"Pizza"

items.items.discounts

object[]

List of discounts of the order line item. Discounts of items are always part of the total discount of the order

Example:

[]

items.items.product_id

string

Reference to the product related to this item

Example:

"789"

items.items.accounting_category_id

string

Sometimes used by a POS to give a specific accounting category to an order item

Example:

"123"

items.order_number

string

Order number (often unique reference during the day)

Example:

"1"

items.closing_date

string

Closing date of the order

Example:

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

items.service_date

string

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"

items.device_id

string

ID of device that created the order

Example:

"device-123"

items.total_discount

number

default:0

Total amount of the discounts of the order

Example:

10

items.total_refund

number

default:0

Total amount of the refunds of the order

Example:

5

items.total_tip

number

default:0

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

Example:

1

items.delivery_fee

number

default:0

Total amount of the delivery fees of the order

Example:

1

items.currency

string

Currency of the order

Example:

"EUR"

items.country

string

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

Example:

"FR"

items.loyalty

integer

Loyalty points of the order

Example:

100

items.customer_id

string

Unique identifier of the customer

Example:

"customer-123"

items.location_id

string

Unique identifier of the location

Example:

"location-123"

items.taxes

object[]

List of taxes of the order

items.guests

integer

Number of guests linked to the order

Example:

1

items.service_id

string

Reference to the service related to this order

items.reservation

object

Reference to the reservation related to this order

items.bills

object[]

Reference to the bills related to this order

items.bills.id

string

required

Technical id in Chift

items.bills.source_ref

object

required

Technical id in the target software

items.bills.invoice_number

string

Number/sequence

items.bills.creation_date

string

Creation date of the invoice

items.bills.closing_date

string

Closing date of the invoice

items.bills.partners

object[]

List of partners related to the invoice

total

integer

required

Required range: x >= 0

page

integer

required

Required range: x >= 1

size

integer

required

Required range: x >= 1

Get all tax rates Get invoices (PMS)

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
}