Skip to main content

Documentation Index

Fetch the complete documentation index at: https://developer.clopos.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Purpose

Fetches the statuses, customer details, and line items of your multi-channel orders in a single request.

​
HTTP Request

GET https://integrations.clopos.com/open-api/v2/orders
This endpoint requires authentication. Include your JWT in the x-token header. See Authentication for how to obtain a token and Errors for error responses.

​
Query Parameters

​
page
integer
default:"1"
Page number for pagination (1-based).
​
limit
integer
default:"50"
Number of orders per page.
​
status
string
Lifecycle state to filter by. Allowed values: PENDING, RECEIVED, IGNORE, DELIVERED.
​
with[]
array[string]
Related resources to include in each order. Repeat with indexed brackets (e.g. with[0]=customer&with[1]=receipt).
​
date[0]
string
Start date of a created_at range, inclusive. Format: YYYY-MM-DD. Pair with date[1].
​
date[1]
string
End date of a created_at range, inclusive. Format: YYYY-MM-DD.
​
sort[0]
string
Field to sort by (e.g. created_at, updated_at, id).
​
sort[1]
integer
Sort direction: 1 = ascending, -1 = descending.
​
filters[N]
array
Additional filter tuples using PHP bracket notation: filters[N][0]=field_name&filters[N][1]=value. Stack filters by incrementing N (0-based).

​
Request Example

curl -X GET "https://integrations.clopos.com/open-api/v2/orders?limit=20&status=DELIVERED" \
  -H "x-token: oauth_example_token" \

​
Response

​
200 OK — Orders list

{
  "success": true,
  "data": [
    {
      "id": 1,
      "venue_id": 1,
      "type": "CALL_CENTER_ORDER",
      "integration": "call_center_new",
      "integration_uuid": null,
      "integration_id": null,
      "customer_ref_id": null,
      "integration_status": "CREATED",
      "status": "RECEIVED",
      "payload": {
        "auto_order_accept": false,
        "auto_order_sent_to_station": false,
        "delivery_fee": 2.5,
        "service": {
          "sale_type_id": 2,
          "venue_id": 1
        },
        "customer": {
          "id": 1,
          "phone": "+994705401040",
          "address": "123 Main St",
          "customer_discount_type": 1,
          "name": "Rahid Akhundzada"
        },
        "products": [
          {
            "product_id": 51,
            "count": 2,
            "product_modificators": [],
            "portion_size": 1,
            "meta": {
              "price": 8.5,
              "order_product": {
                "count": 2,
                "status": "new",
                "product_modificators": [],
                "product_hash": "abc123",
                "product": {
                  "id": 51,
                  "name": "Pizza",
                  "price": 8.5
                }
              }
            }
          }
        ],
        "meta": {
          "comment": "Leave at the door",
          "discount": {
            "discount_type": 1,
            "discount_value": 10
          },
          "apply_service_charge": true,
          "customer_discount_type": 1,
          "service_charge_value": 5
        },
        "customer_id": 1,
        "sale_type_id": 2
      },
      "created_at": "2026-02-02T13:45:53.000000Z",
      "updated_at": "2026-02-02T17:46:02.000000Z",
      "integration_response": null
    }
  ],
  "total": 4
}

​
401 Unauthorized — Authentication is missing or invalid

{
  "success": false,
  "error": "unauthorized",
  "message": "Missing or invalid authentication headers"
}

​
Field Reference

​
Order Object

FieldTypeDescription
idintegerOrder identifier.
venue_idintegerVenue that owns the order.
typestringSource of the order (e.g., CALL_CENTER_ORDER).
integrationstringIntegration channel that created the order (e.g., call_center_new).
integration_uuidstring (nullable)UUID assigned by the integration source.
integration_idstring (nullable)External ID from the integration source.
integration_statusstringState reported by the upstream integration (e.g., CREATED).
customer_ref_idstring (nullable)External customer reference ID from the integration.
statusstringCurrent lifecycle state: PENDING, RECEIVED, IGNORE, DELIVERED.
payloadobjectFull order content including service, customer, products, and meta.
payload.serviceobjectSale type and venue for the order.
payload.customerobjectCustomer details (id, phone, address, name).
payload.productsarrayLine items with product_id, count, modifiers, and pricing meta.
payload.metaobjectOrder-level metadata: comment, discount, service charge settings.
integration_responseobject (nullable)Response data from the integration, if any.
created_atstringCreation timestamp (ISO 8601).
updated_atstringLast update timestamp (ISO 8601).

​
Notes

  • When an order is created through this endpoint, the POS receives a push notification and notifies the clerk of the new order. RECEIVED orders automatically transition into open receipts.
  • Use status=PENDING to monitor orders awaiting POS confirmation.
  • Poll or subscribe to webhooks to track further status changes if your integration requires real-time updates.