List orders - Clopos Open API

GET

orders

List orders

curl --request GET \
  --url https://integrations.clopos.com/open-api/v2/orders \
  --header 'x-token: <api-key>'

{
  "data": [
    {
      "id": "<string>",
      "customer_id": "<string>",
      "total_amount": 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

JWT access token obtained from /v2/auth endpoint

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,

RECEIVED,

IGNORE,

DELIVERED

Response

200 - application/json

Orders retrieved successfully

data

object[]

Show child attributes

pagination

object

Show child attributes

Create orderCreate a new order using the streamlined v2 payload with flat schema, customer object, and products array.

List orders

curl --request GET \
  --url https://integrations.clopos.com/open-api/v2/orders \
  --header 'x-token: <api-key>'

{
  "data": [
    {
      "id": "<string>",
      "customer_id": "<string>",
      "total_amount": 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
  }
}