Purpose
Send a simple status update to mark an order as ignored.
HTTP Request
PUT https://integrations.clopos.com/open-api/v2/orders/{id}
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. Path Parameters
Unique identifier of the order.
Request Body
| Field | Type | Required | Description |
|---|
status | string | Yes | Set to IGNORE to cancel the order. |
Request Example
curl --location --request PUT 'https://integrations.clopos.com/open-api/v2/orders/108' \
--header 'Content-Type: application/json' \
--header 'x-token: oauth_example_token' \
--data '{
"status": "IGNORE"
}'
Response
200 OK — Order updated
{
"success": true,
"data": {
"id": 108,
"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": "IGNORE",
"created_at": "2026-02-02T13:45:53.000000Z",
"updated_at": "2026-02-02T17:46:02.000000Z",
"integration_response": null
}
}
400 Bad Request — Invalid status
{
"success": false,
"error": "validation_failed",
"message": "Status is not allowed"
}
Field Reference
| Field | Type | Description |
|---|
id | integer | Order identifier. |
venue_id | integer | Venue that owns the order. |
type | string | Source of the order. |
integration | string | Integration channel. |
integration_uuid | string (nullable) | UUID from the integration source. |
integration_id | string (nullable) | External ID from the integration source. |
customer_ref_id | string (nullable) | External customer reference ID. |
integration_status | string | State reported by the upstream integration. |
status | string | Updated lifecycle state (e.g., IGNORE). |
integration_response | object (nullable) | Response data from the integration, if any. |
created_at | string | Creation timestamp (ISO 8601). |
updated_at | string | Last update timestamp (ISO 8601). |
Notes
- Request body must include only the status field as shown.
- Currently, only the
IGNORE status transition is supported through this endpoint.
