Get orders

curl --request GET \
  --url https://api.chift.eu/consumers/{consumer_id}/pos/orders

const options = {method: 'GET'};

fetch('https://api.chift.eu/consumers/{consumer_id}/pos/orders', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.chift.eu/consumers/{consumer_id}/pos/orders",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.chift.eu/consumers/{consumer_id}/pos/orders"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.chift.eu/consumers/{consumer_id}/pos/orders")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "items": [
    {
      "id": "371ca583-d218-4900-b236-397532cf0e52",
      "creation_date": "2025-01-01T00:00:00Z",
      "total": 11,
      "tax_amount": 1,
      "payments": [
        {
          "total": 11,
          "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",
          "invoice_ref": "invoice-123",
          "order_id": "order-123"
        }
      ],
      "items": [
        {
          "id": "123",
          "quantity": 1,
          "unit_price": 10,
          "total": 11,
          "tax_amount": 1,
          "type": "product",
          "menu_id": "456",
          "tax_rate": 10,
          "tax_id": "371ca583-d218-4900-b236-397532cf0e39",
          "description": "Pizza",
          "discounts": [],
          "product_id": "789",
          "accounting_category_id": "123",
          "modifiers": []
        }
      ],
      "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,
      "mode": "eat_in",
      "source": "web",
      "currency": "EUR",
      "country": "FR",
      "loyalty": 100,
      "customer_id": "customer-123",
      "location_id": "location-123",
      "taxes": [],
      "guests": 1,
      "invoice_id": "invoice-123"
    }
  ],
  "total": 1,
  "page": 2,
  "size": 2
}

{
  "message": "Error while trying to perform your request",
  "status": "error"
}

{
  "message": "The resource {Method} - {Resource} is not supported by {ConnectorName}",
  "status": "error"
}

{
  "message": "Validation error",
  "status": "error",
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

{
  "message": "Error while trying to authenticate to {ConnectorName}",
  "status": "error"
}

GET

consumers

{consumer_id}

pos

orders

Get orders

curl --request GET \
  --url https://api.chift.eu/consumers/{consumer_id}/pos/orders

const options = {method: 'GET'};

fetch('https://api.chift.eu/consumers/{consumer_id}/pos/orders', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.chift.eu/consumers/{consumer_id}/pos/orders",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.chift.eu/consumers/{consumer_id}/pos/orders"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.chift.eu/consumers/{consumer_id}/pos/orders")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "items": [
    {
      "id": "371ca583-d218-4900-b236-397532cf0e52",
      "creation_date": "2025-01-01T00:00:00Z",
      "total": 11,
      "tax_amount": 1,
      "payments": [
        {
          "total": 11,
          "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",
          "invoice_ref": "invoice-123",
          "order_id": "order-123"
        }
      ],
      "items": [
        {
          "id": "123",
          "quantity": 1,
          "unit_price": 10,
          "total": 11,
          "tax_amount": 1,
          "type": "product",
          "menu_id": "456",
          "tax_rate": 10,
          "tax_id": "371ca583-d218-4900-b236-397532cf0e39",
          "description": "Pizza",
          "discounts": [],
          "product_id": "789",
          "accounting_category_id": "123",
          "modifiers": []
        }
      ],
      "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,
      "mode": "eat_in",
      "source": "web",
      "currency": "EUR",
      "country": "FR",
      "loyalty": 100,
      "customer_id": "customer-123",
      "location_id": "location-123",
      "taxes": [],
      "guests": 1,
      "invoice_id": "invoice-123"
    }
  ],
  "total": 1,
  "page": 2,
  "size": 2
}

{
  "message": "Error while trying to perform your request",
  "status": "error"
}

{
  "message": "The resource {Method} - {Resource} is not supported by {ConnectorName}",
  "status": "error"
}

{
  "message": "Validation error",
  "status": "error",
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

{
  "message": "Error while trying to authenticate to {ConnectorName}",
  "status": "error"
}

Learn more:

What is an order? ↗
How are amounts and taxes rounded? ↗

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. Ignored when 'closure_id' is provided.

date_to

string<date> | null

End date (inclusive) of the period to get orders from. Ignored when 'closure_id' is provided.

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. Scopes the result to that closure instead of a date range: when provided, 'date_from' and 'date_to' are ignored and every order of the closure is returned, whatever its date. If none passed, orders from all closures in the period will be selected.

Response

Successful Response

items

POSOrderItem · object[]

required

Show child attributes

total

integer

required

Required range: x >= 0

page

integer

required

Required range: x >= 1

size

integer

required

Required range: x >= 1

API Reference Overview

Access & Connections

Accounting

Invoicing

POS

eCommerce

PMS

Payment

Banking

Other

Get orders

Path Parameters

Query Parameters

Response