Sign in

v1

latestOpenAPI 3.1.02026-07-22155403592.5 KB
Point of Sale
Orders

Update order

Update one order

patch/consumers/{consumer_id}/pos/orders/{order_id}

Path parameters

consumer_idstring uuid required
order_idstring required

Unique identifier of the order

Request body

customer_idstring nullable

Unique identifier of the customer

Example request

{
  "customer_id": "371ca583-d218-4900-b236-397532cf0e52"
}

Response

Successful Response

idstring required

Unique identifier of the order

order_numberstring nullable

Order number (often unique reference during the day)

creation_datestring date-time required

Creation date of the order

closing_datestring date-time nullable

Closing date of the order

service_datestring date-time nullable

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

device_idstring nullable

ID of device that created the order

totalnumber required

Total amount including tax of the order

tax_amountnumber required

Total amount of the taxes of the order

total_discountnumber nullable

Total amount of the discounts of the order

total_refundnumber nullable

Total amount of the refunds of the order

total_tipnumber nullable

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

delivery_feenumber nullable

Total amount of the delivery fees of the order

mode'EAT_IN' | 'TAKEAWAY' | 'DELIVERY' | 'UNKNOWN'
source'WEB' | 'MOBILE' | 'KIOSK' | 'POS' | 'REMOTE_POS' | 'JUSTEAT' | 'FOODORA' | 'UBEREATS' | 'GLOVO' | 'DELIVEROO' | 'SMILEIN' | 'UNKNOWN'
currencystring nullable

Currency of the order

countrystring nullable

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

loyaltyinteger nullable

Loyalty points of the order

customer_idstring nullable

Unique identifier of the customer

location_idstring nullable

Unique identifier of the location

guestsinteger nullable

Number of guests linked to the order

Example response

{
  "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_id": "371ca583-d218-4900-b236-397532cf0e39"
    }
  ],
  "guests": 1,
  "payments": [
    {
      "id": "payment-123",
      "payment_method_id": "payment-method-123",
      "payment_method_name": "Cash",
      "total": 11,
      "tip": 1,
      "currency": "EUR",
      "date": "2025-01-01T00:00:00Z",
      "invoice_ref": "invoice-123"
    }
  ],
  "items": [
    {
      "id": "123",
      "menu_id": "456",
      "quantity": 1,
      "unit_price": 10,
      "total": 11,
      "tax_amount": 1,
      "tax_rate": 10,
      "tax_id": "371ca583-d218-4900-b236-397532cf0e39",
      "description": "Pizza",
      "discounts": [],
      "product_id": "789",
      "accounting_category_id": "123"
    }
  ]
}