---
title: "Get orders"
method: GET
path: "/consumers/{consumer_id}/pos/orders"
tags: ["Point of Sale", "Orders"]
---

# Get orders

`GET /consumers/{consumer_id}/pos/orders`

Returns a list of the orders

## Path parameters

- `consumer_id` string, uuid, required

## Query parameters

- `page` integer
- `size` integer
- `date_from` string, date, nullable
- `date_to` string, date, nullable
- `location_id` string, nullable
- `state` 'open' | 'closed' | 'all'
- `closure_id` string, nullable

## Response `200`

Successful Response

- ChiftPagePOSOrderItem
  - `items` POSOrderItem[], required
    - `id` string, required — Unique identifier of the order
    - `order_number` string, nullable — Order number (often unique reference during the day)
    - `creation_date` string, date-time, required — Creation date of the order
    - `closing_date` string, date-time, nullable — Closing date of the order
    - `service_date` string, date-time, nullable — Indicates the date of the service to which the order belongs (can be used to group orders by closure date)
    - `device_id` string, nullable — ID of device that created the order
    - `total` number, required — Total amount including tax of the order
    - `tax_amount` number, required — Total amount of the taxes of the order
    - `total_discount` number, nullable — Total amount of the discounts of the order
    - `total_refund` number, nullable — Total amount of the refunds of the order
    - `total_tip` number, nullable — Total amount of the tips of the order. Tips are not part of the total of the order
    - `delivery_fee` number, 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'
    - `currency` string, nullable — Currency of the order
    - `country` string, nullable — Country of the order, format: ISO 3166-1 codes.
    - `loyalty` integer, nullable — Loyalty points of the order
    - `customer_id` string, nullable — Unique identifier of the customer
    - `location_id` string, nullable — Unique identifier of the location
    - `taxes` TotalTaxItem[], nullable — List of taxes of the order
      - `tax_id` string, nullable — Unique identifier of the tax
      - `tax_rate` number, required — Tax rate
      - `tax_amount` number, required — Tax amount
      - `total` number, required — Total amount including tax
    - `guests` integer, nullable — Number of guests linked to the order
    - `payments` POSPaymentItem[], required — List of payments made for the order
      - `id` string, nullable — Unique identifier of the payment
      - `payment_method_id` string, nullable — Unique identifier of the payment method used for the payment
      - `payment_method_name` string, nullable — Chift's name of the payment method used for the payment
      - `total` number, required — Total amount of the payment
      - `tip` number, nullable — Total amount of the tips of the payment. Tips are not part of the total of the payment
      - `status` 'Pending' | 'Completed' | 'Canceled' | 'Failed' | 'Unknown' | 'Authorised'
      - `currency` string, nullable — Currency of the payment
      - `date` string, date-time, nullable — Date of the payment
      - `invoice_ref` string, nullable — Reference of the invoice linked to the payment
    - `items` POSItem[], required — List of item lines in the order
      - `id` string, required — Unique identifier of the order line item
      - `type` 'menu' | 'product' | 'service' | 'general_discount'
      - `menu_id` string, nullable — Unique identifier of the menu
      - `quantity` number, required — Quantity of the order line item
      - `unit_price` number, required — Unit price (without tax) of the order line item
      - `total` number, required — Total amount including tax of the order line item
      - `tax_amount` number, required — Total amount of the taxes of the order line item
      - `tax_rate` number, nullable — Tax rate of the order line item
      - `tax_id` string, nullable — Unique identifier of the tax of the order line item
      - `description` string, nullable — Description of the order line item
      - `discounts` DiscountItem[], nullable — List of discounts of the order line item. Discounts of items are always part of the total discount of the order
        - `name` string, nullable — Name of the discount
        - `total` number, required — Total amount of the discount
        - `type` 'OFFERED' | 'UNKNOWN' | 'LOSS'
      - `product_id` string, nullable — Reference to the product related to this item
      - `accounting_category_id` string, nullable — Sometimes used by a POS to give a specific accounting category to an order item
  - `total` integer, required
  - `page` integer, required
  - `size` integer, required

## Other responses

- `400` — Bad Request
- `405` — Method Not Allowed
- `422` — Validation Error
- `502` — Bad Gateway

---

[API](https://skmtc.net/chift/apis/chift-api.md) · [All operations](https://skmtc.net/chift/apis/chift-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/chift/chift-api/revisions/b5f1214a482a/schema)