Skip to main content
GET
/
orders
/
{id}
Get order by ID
curl --request GET \
  --url https://integrations.clopos.com/open-api/orders/{id} \
  --header 'x-brand: <api-key>' \
  --header 'x-token: <api-key>' \
  --header 'x-venue: <api-key>'
"<any>"

​
Purpose

Return a specific order so you can inspect its metadata, customer, payment, and fulfillment status without fetching the entire list.

​
HTTP Request

GET https://integrations.clopos.com/open-api/orders/{id}

​
Path Parameters

​
id
string
required
Unique identifier of the order (ORD-12345, UUID, or numeric ID depending on your tenant).

​
Request Example

curl --location "https://integrations.clopos.com/open-api/orders/75" \
  -H "x-token: oauth_example_token" \
  -H "x-brand: openapitest" \
  -H "x-venue: 1"

​
Response

​
200 OK — Order found

{
  "success": true,
  "data": {
    "id": 75,
    "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": "PENDING",
    "receive_user_id": 1,
    "receive_terminal_id": null,
    "payload": {
      "service": {
        "sale_type_id": 3,
        "venue_id": 1
      },
      "customer": {
        "id": 2,
        "customer_discount_type": 1,
        "name": "John Doe"
      },
      "products": [
        {
          "product_id": 140,
          "count": 1,
          "product_modificators": [],
          "meta": {
            "price": 4,
            "order_product": {
              "product": {
                "id": 140,
                "name": "Göbələk şorbası",
                "price": 4
              },
              "count": 1,
              "status": "completed",
              "product_modificators": [],
              "product_hash": "140"
            }
          }
        }
      ],
      "meta": {
        "comment": null,
        "discount": {
          "discount_type": 1,
          "discount_value": 0
        },
        "orderTotal": "4.0000",
        "apply_service_charge": true,
        "customer_discount_type": 1,
        "service_charge_value": 0
      },
      "customer_id": 2,
      "sale_type_id": 3,
      "payload_updated_at": "2025-10-16 18:44:01.428"
    },
    "created_at": "2025-10-16T09:11:55.000000Z",
    "updated_at": "2025-10-16T09:11:55.000000Z",
    "integration_response": null,
    "properties": {
      "agent_id": 1
    }
  },
  "time": 64,
  "timestamp": "2025-10-16 18:44:01",
  "unix": 1760640241
}

​
404 Not Found — Order does not exist

{
  "success": false,
  "error": "resource_not_found",
  "message": "Order not found"
}

​
Field Reference

FieldTypeDescription
idnumberOrder identifier returned during creation or list operations.
venue_idnumberVenue that owns the order.
typestringSource of the order (for example, CALL_CENTER_ORDER).
integration_statusstringState reported by the upstream integration.
statusstringCurrent lifecycle state (PENDING, ACCEPTED, COMPLETED, CANCELLED).
payloadobjectFull payload captured during creation (service, customer, products, meta).
payload.customer.idnumberLinked customer record (if available).
payload.products[]arrayBreakdown of products, modifiers, and totals.
created_atstringCreation timestamp (ISO 8601).
updated_atstringLast update timestamp (ISO 8601).

​
Notes

  • Returns the same structure as the list endpoint, providing parity between detail and collection responses.
  • Use this endpoint after receiving webhook notifications to hydrate UI with complete order data.
  • Combine with the receipts endpoint when you need final settlement information once the order is accepted.

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

Path Parameters

​
id
string
required

Order ID

Response

Order retrieved successfully

The response is of type any.