Skip to main content
PATCH
/
consumers
/
{consumer_id}
/
pos
/
orders
/
{order_id}
Update order
curl --request PATCH \
  --url https://api.chift.eu/consumers/{consumer_id}/pos/orders/{order_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "customer_id": "371ca583-d218-4900-b236-397532cf0e52"
}'
{
  "id": "371ca583-d218-4900-b236-397532cf0e52",
  "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": [
    {
      "tax_rate": "10",
      "tax_amount": "1",
      "total": "11"
    }
  ],
  "guests": 1,
  "payments": [
    {
      "id": "payment-123",
      "payment_method_id": "payment-method-123",
      "payment_method_name": "Cash",
      "total": 11,
      "tip": 1,
      "status": "Completed",
      "currency": "EUR",
      "date": "2025-01-01T00:00:00Z"
    }
  ],
  "items": [
    {
      "id": "123",
      "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"
    }
  ]
}

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
​
order_id
string
required

Unique identifier of the order

Body

application/json
​
customer_id
string | null

Unique identifier of the customer

Examples:

"371ca583-d218-4900-b236-397532cf0e52"

Response

Successful Response

​
id
string
required

Unique identifier of the order

Examples:

"371ca583-d218-4900-b236-397532cf0e52"

​
creation_date
string<date-time>
required

Creation date of the order

Examples:

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

​
total
number
required

Total amount including tax of the order

Examples:

11

​
tax_amount
number
required

Total amount of the taxes of the order

Examples:

1

​
payments
POSPaymentItem · object[]
required

List of payments made for the order

​
items
POSItem · object[]
required

List of item lines in the order

​
order_number
string | null

Order number (often unique reference during the day)

Examples:

"1"

​
closing_date
string<date-time> | null

Closing date of the order

Examples:

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

​
service_date
string<date-time> | null

Indicates the date of the service to which the order belongs (can be used to group orders by closure date)

Examples:

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

​
device_id
string | null

ID of device that created the order

Examples:

"device-123"

​
total_discount
number | null
default:0

Total amount of the discounts of the order

Examples:

10

​
total_refund
number | null
default:0

Total amount of the refunds of the order

Examples:

5

​
total_tip
number | null
default:0

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

Examples:

1

​
delivery_fee
number | null
default:0

Total amount of the delivery fees of the order

Examples:

1

​
currency
string | null

Currency of the order

Examples:

"EUR"

​
country
string | null

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

Examples:

"FR"

​
loyalty
integer | null

Loyalty points of the order

Examples:

100

​
customer_id
string | null

Unique identifier of the customer

Examples:

"customer-123"

​
location_id
string | null

Unique identifier of the location

Examples:

"location-123"

​
taxes
TotalTaxItem · object[] | null

List of taxes of the order

​
guests
integer | null

Number of guests linked to the order

Examples:

1

⌘I