Purpose
Update specific fields of a receipt. Only the provided fields will be updated; all other fields remain unchanged.HTTP Request
Path Parameters
| Parameter | Type | Description |
|---|---|---|
id | number | Unique 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:| Field | Type | Description |
|---|---|---|
order_status | string | Order status. Valid values: "NEW", "SCHEDULED", "IN_PROGRESS", "READY", "PICKED_UP", "COMPLETED", "CANCELLED". |
order_number | string | Order number identifier (e.g., "RPO-00001"). |
fiscal_id | string | Fiscal receipt identifier. |
lock | boolean | Lock status of the receipt (true or false). |
Request Example
Response
200 OK — Receipt Updated
The response returns the full receipt data with all fields updated:404 Not Found — Receipt Not Found
400 Bad Request — Validation Error
Field Reference
Updateable Fields
| Field | Type | Description |
|---|---|---|
order_status | string | Current order status. Valid values: "NEW", "SCHEDULED", "IN_PROGRESS", "READY", "PICKED_UP", "COMPLETED", "CANCELLED". |
order_number | string | External order number or identifier. |
fiscal_id | string | Fiscal receipt identifier used for tax reporting. |
lock | boolean | If 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
Access token obtained from /auth endpoint
Brand identifier
Venue identifier
Path Parameters
Receipt ID
Body
application/json
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 identifier
Fiscal receipt identifier
Lock status of the receipt