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>'
{
  "error": "<string>",
  "message": "<string>",
  "details": {}
}

​
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).

​
Query Parameters

​
with[0]
string
Include related resources in the response. Currently supported: receipt:id,service_notification_id,status. When included, the data.receipt field will be present in the response (or null if no receipt exists for the order).

​
Request Example

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

# Request including receipt (note: --globoff to avoid shell globbing)
curl --location --globoff 'https://integrations.clopos.com/open-api/orders/238?with[0]=receipt%3Aid%2Cservice_notification_id%2Cstatus' \
  -H "x-token: oauth_example_token" \
  -H "x-brand: openapitest" \
  -H "x-venue: 1"

​
Response

​
200 OK — Order found

{
    "success": true,
    "data": {
        "id": 238,
        "venue_id": 1,
        "type": "CALL_CENTER_ORDER",
        "integration": "call_center_new",
        "integration_uuid": null,
        "integration_id": null,
        "customer_ref_id": "63d92187d2960bde1d66048c",
        "integration_status": "CREATED",
        "status": "RECEIVED",
        "receive_user_id": 1,
        "receive_terminal_id": 1,
        "payload": {
            "service": {
                "sale_type_id": 2,
                "venue_id": 1
            },
            "customer": {
                "id": 9,
                "customer_discount_type": 0,
                "name": "Rahid Akhundzada"
            },
            "products": [
                {
                    "product_id": 140,
                    "count": 1,
                    "product_modificators": [],
                    "meta": {
                        "price": 4,
                        "order_product": {
                            "product": {
                                "id": 420,
                                "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": 9,
            "sale_type_id": 2,
            "payload_updated_at": "2025-10-30 08:27:10.066"
        },
        "created_at": "2025-10-29T07:54:39.000000Z",
        "updated_at": "2025-10-29T11:55:17.000000Z",
        "integration_response": null,
        "properties": {
            "agent_id": 1
        },
        "receipt": {
            "id": 10890,
            "service_notification_id": 238,
            "status": 1,
            "total_discount": 0,
            "properties": {
                "daily_id": 4,
                "monthly_id": 40,
                "changes": {
                    "discount_type": {
                        "timestamp": 1761724517299,
                        "oldValue": null,
                        "newValue": 1
                    },
                    "customer_id": {
                        "timestamp": 1761724517299,
                        "oldValue": null,
                        "newValue": 9
                    },
                    "description": {
                        "timestamp": 1761724591928,
                        "oldValue": null,
                        "newValue": "teee"
                    },
                    "order_status": {
                        "timestamp": 1761725608494,
                        "oldValue": "IN_PROGRESS",
                        "newValue": "READY"
                    }
                }
            }
        }
    },
    "time": 79,
    "timestamp": "2025-10-30 08:27:10",
    "unix": 1761812830
}

​
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, RECEIVED, IGNORE, DELIVERED).
payloadobjectFull payload captured during creation (service, customer, products, meta).
payload.customer.idnumberLinked customer record (if available).
payload.products[]arrayBreakdown of products, modifiers, and totals.
receiptobject | nullPresent when with[0]=receipt:... is provided. Contains minimal receipt data or null if no receipt exists.
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.
  • You can embed the linked receipt using the with[0] parameter. If the order has no receipt, receipt will be null.
  • Combine with the receipts endpoint when you need final settlement information once the order is delivered.

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

Query Parameters

​
with[0]
string

Include related resources. Supported: receipt:id,service_notification_id,status

Response

Order retrieved successfully