Skip to main content
PATCH
/
receipts
/
{id}
Update receipt
curl --request PATCH \
  --url https://integrations.clopos.com/open-api/receipts/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-brand: <api-key>' \
  --header 'x-token: <api-key>' \
  --header 'x-venue: <api-key>' \
  --data '{
  "order_status": "NEW",
  "order_number": "<string>",
  "fiscal_id": "<string>",
  "lock": true
}'
{
  "success": true,
  "data": {
    "id": 123,
    "venue_id": 123,
    "cash_shift_cid": "<string>",
    "cid": "<string>",
    "user_id": 123,
    "open_by_user_id": 123,
    "close_by_user_id": 123,
    "courier_id": 123,
    "seller_id": 123,
    "terminal_id": 123,
    "source": "<string>",
    "closed_terminal_id": 123,
    "service_notification_id": 123,
    "table_id": 123,
    "hall_id": 123,
    "customer_id": 123,
    "sale_type_id": 123,
    "is_returns": true,
    "guests": 123,
    "status": 123,
    "lock": true,
    "inventory_status": 123,
    "report_status": 123,
    "meta": {
      "preprint_count": 123,
      "sale_type": {
        "name": "<string>"
      },
      "user": {
        "name": "<string>"
      },
      "terminal_updated_at": 123,
      "availiableDeposit": 123,
      "check_close_event": {
        "checked": true,
        "operated_at": "<string>",
        "fails": [
          "<any>"
        ]
      }
    },
    "suspicion": 123,
    "printed": true,
    "total": 123,
    "subtotal": 123,
    "original_subtotal": 123,
    "gift_total": 123,
    "totalCost": 123,
    "payment_methods": [
      {
        "id": 123,
        "name": "<string>",
        "amount": 123
      }
    ],
    "fiscal_id": "<string>",
    "by_cash": 123,
    "by_card": 123,
    "remaining": 123,
    "discount_type": 123,
    "discount_value": 123,
    "discount_rate": 123,
    "rps_discount": 123,
    "service_charge": 123,
    "service_charge_value": 123,
    "i_tax": 123,
    "delivery_fee": 123,
    "e_tax": 123,
    "total_tax": 123,
    "description": "<string>",
    "address": "<string>",
    "terminal_version": "<string>",
    "loyalty_type": "<string>",
    "loyalty_value": 123,
    "order_status": "<string>",
    "order_number": "<string>",
    "created_at": "<string>",
    "updated_at": "<string>",
    "terminal_updated_at": "<string>",
    "closed_at": "<string>",
    "shift_date": "<string>",
    "deleted_at": "<string>",
    "gift_count": 123,
    "total_discount": 123,
    "properties": {
      "daily_id": 123,
      "monthly_id": 123
    },
    "receipt_products": [
      {
        "id": 123,
        "cid": "<string>",
        "product_id": 123,
        "receipt_id": 123,
        "product_hash": "<string>",
        "meta": {},
        "count": 123,
        "portion_size": 123,
        "total": 123,
        "price": 123,
        "cost": 123,
        "is_gift": true,
        "preprint_count": 123,
        "station_printed_count": 123,
        "station_aborted_count": 123,
        "seller_id": 123,
        "loyalty_type": "<string>",
        "loyalty_value": 123,
        "discount_rate": 123,
        "discount_value": 123,
        "discount_type": 123,
        "total_discount": 123,
        "subtotal": 123,
        "receipt_discount": 123,
        "created_at": "<string>",
        "updated_at": "<string>",
        "terminal_updated_at": "<string>",
        "deleted_at": "<string>",
        "receipt_product_modificators": [
          "<any>"
        ],
        "taxes": [
          "<any>"
        ]
      }
    ],
    "stock_operations": [
      "<any>"
    ],
    "customer": {}
  },
  "time": 123,
  "timestamp": "<string>",
  "unix": 123,
  "message": "<string>"
}

Purpose

Update specific fields of a receipt. Only the provided fields will be updated; all other fields remain unchanged.

HTTP Request

PATCH https://integrations.clopos.com/open-api/receipts/{id}

Path Parameters

ParameterTypeDescription
idnumberUnique identifier of the receipt to update.

Request Body

Only the fields you want to update need to be included in the request body. Available updateable fields:
FieldTypeDescription
order_statusstringOrder status. Valid values: "NEW", "SCHEDULED", "IN_PROGRESS", "READY", "PICKED_UP", "COMPLETED", "CANCELLED".
order_numberstringOrder number identifier (e.g., "RPO-00001").
fiscal_idstringFiscal receipt identifier.
lockbooleanLock status of the receipt (true or false).

Request Example

curl --location --request PATCH 'https://integrations.clopos.com/open-api/receipts/1' \
  --header 'Content-Type: application/json' \
  --header 'x-token: oauth_example_token' \
  --header 'x-brand: openapitest' \
  --header 'x-venue: 1' \
  --data '{
    "order_status": "NEW",
    "order_number": "RPO-00001",
    "fiscal_id": "Twrewr89fnscvj22",
    "lock": false
}'

Response

200 OK — Receipt Updated

The response returns the full receipt data with all fields updated:
{
    "success": true,
    "data": {
        "id": 1,
        "venue_id": 1,
        "cash_shift_cid": null,
        "cid": "43025959-0e82-4fbd-bcc7-1bc0101183b7",
        "user_id": 1,
        "open_by_user_id": null,
        "close_by_user_id": null,
        "courier_id": null,
        "seller_id": null,
        "terminal_id": 1,
        "source": "web",
        "closed_terminal_id": null,
        "service_notification_id": null,
        "table_id": null,
        "hall_id": null,
        "customer_id": null,
        "sale_type_id": 1000,
        "is_returns": null,
        "guests": 1,
        "status": 2,
        "lock": false,
        "inventory_status": 0,
        "report_status": 3,
        "meta": {
            "preprint_count": 0,
            "sale_type": {
                "name": "Satis usulu 1"
            },
            "user": {
                "name": "Clopos"
            },
            "terminal_updated_at": 1755524813947,
            "availiableDeposit": 30000,
            "check_close_event": {
                "checked": true,
                "operated_at": "2025-08-19 16:01:16",
                "fails": []
            }
        },
        "suspicion": 0,
        "printed": false,
        "total": 30000,
        "subtotal": 30000,
        "original_subtotal": 30000,
        "gift_total": 0,
        "totalCost": 0,
        "payment_methods": [
            {
                "id": 1,
                "name": "Cash",
                "amount": 30000
            }
        ],
        "fiscal_id": "Twrewr89fnscvj22",
        "by_cash": 30000,
        "by_card": 0,
        "remaining": 0,
        "discount_type": 0,
        "discount_value": 0,
        "discount_rate": 0,
        "rps_discount": 0,
        "service_charge": 0,
        "service_charge_value": 0,
        "i_tax": 0,
        "delivery_fee": 0,
        "e_tax": 0,
        "total_tax": 0,
        "description": null,
        "address": null,
        "terminal_version": null,
        "loyalty_type": null,
        "loyalty_value": null,
        "order_status": "NEW",
        "order_number": "RPO-00001",
        "created_at": "2025-08-18 13:45:16",
        "updated_at": "2025-10-29 12:43:07",
        "terminal_updated_at": null,
        "closed_at": "2025-08-18 14:47:05",
        "shift_date": "2025-08-18",
        "deleted_at": null,
        "total_discount": 0,
        "properties": {
            "daily_id": 1,
            "monthly_id": 1
        }
    },
    "message": "Əməliyyat uğurla həyata keçirildi",
    "time": 92,
    "timestamp": "2025-10-29 12:43:07",
    "unix": 1761741787
}

404 Not Found — Receipt Not Found

{
  "success": false,
  "error": "not_found",
  "message": "Receipt not found"
}

400 Bad Request — Validation Error

{
  "success": false,
  "error": "validation_failed",
  "message": "Invalid field values provided"
}

Field Reference

Updateable Fields

FieldTypeDescription
order_statusstringCurrent order status. Valid values: "NEW", "SCHEDULED", "IN_PROGRESS", "READY", "PICKED_UP", "COMPLETED", "CANCELLED".
order_numberstringExternal order number or identifier.
fiscal_idstringFiscal receipt identifier used for tax reporting.
lockbooleanIf true, locks the receipt to prevent further modifications.

Notes

  • Only the fields provided in the request body will be updated; all other fields remain unchanged.
  • The response includes the complete receipt object with all fields, not just the updated ones.
  • Only the specified fields (order_status, order_number, fiscal_id, lock) can be updated through this endpoint.
  • Other receipt fields are read-only and cannot be modified via this API.

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
integer
required

Receipt ID

Body

application/json
order_status
enum<string> | null

Order status. Valid values: NEW, SCHEDULED, IN_PROGRESS, READY, PICKED_UP, COMPLETED, CANCELLED

Available options:
NEW,
SCHEDULED,
IN_PROGRESS,
READY,
PICKED_UP,
COMPLETED,
CANCELLED
order_number
string | null

Order number identifier

fiscal_id
string | null

Fiscal receipt identifier

lock
boolean

Lock status of the receipt

Response

Receipt updated successfully

success
boolean
data
object
time
integer
timestamp
string
unix
integer
message
string