Skip to main content
PUT
/
orders
/
{id}
Update order
curl --request PUT \
  --url https://integrations.clopos.com/open-api/orders/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-brand: <api-key>' \
  --header 'x-token: <api-key>' \
  --header 'x-venue: <api-key>' \
  --data '"<any>"'
"<any>"

​
Purpose

Send a simple status update to mark an order as ignored.

​
HTTP Request

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

​
Path Parameters

​
id
string
required
Unique identifier of the order.

​
Request Body

FieldTypeRequiredDescription
statusstring✓Set to IGNORE to cancel the order.

​
Request Example

curl --location --request PUT 'https://integrations.clopos.com/open-api/orders/108' \
  --header 'Content-Type: application/json' \
  --header 'x-token: oauth_example_token' \
  --header 'x-brand: openapitest' \
  --header 'x-venue: 1' \
  --data '{
        "status": "IGNORE"
  }'

​
Response

​
200 OK — Order updated

{
  "success": true,
  "data": {
    "id": 108,
    "status": "IGNORE"
  },
  "timestamp": "2025-10-23 14:13:09",
  "unix": 1761211989
}

​
400 Bad Request — Invalid status

{
  "success": false,
  "error": "validation_failed",
  "message": "Status is not allowed"
}

​
Notes

  • Request body must include only the status field as shown.

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

Body

application/json · any

The body is of type any.

Response

Order updated successfully

The response is of type any.