Skip to main content
GET
/
orders
List orders
curl --request GET \
  --url https://integrations.clopos.com/open-api/orders \
  --header 'x-brand: <api-key>' \
  --header 'x-token: <api-key>' \
  --header 'x-venue: <api-key>'
{
  "data": [
    {
      "id": "<string>",
      "customer_id": "<string>",
      "status": "pending",
      "total_amount": 123,
      "line_items": [
        {
          "id": "<string>",
          "product_id": "<string>",
          "quantity": 2,
          "unit_price": 123,
          "total_price": 123
        }
      ],
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "page": 123,
    "per_page": 123,
    "total": 123,
    "total_pages": 123
  }
}

Authorizations

x-token
string
header
required

Access token obtained from /auth endpoint

x-brand
string
header
required

Brand identifier

x-venue
string
header
required

Venue identifier

Query Parameters

limit
integer
default:20

Maximum number of orders to return (1-100)

Required range: 1 <= x <= 100
status
enum<string>

Filter by order status

Available options:
pending,
confirmed,
completed,
cancelled

Response

200 - application/json

Orders retrieved successfully

data
object[]
pagination
object