Orders
Sales order data - the primary transaction entity.
Fields
| Field | Type | Required | Version | Description |
|---|---|---|---|---|
customer_id |
integer | Yes | 1.0 | Reference to Customer. Entity owning the order. |
name |
string | No | 1.0 | Name set on order in POS. Can contain order-split info (/1, /2 etc) |
type |
string | Yes | 1.0 | Order type. Values: sales, refund, deposit, invoice, internalsales |
revenue_unit_id |
integer | No | 1.0 | Reference to RevenueUnit |
revenue_unit_name |
string | No | 1.0 | Denormalized revenue unit name |
order_type_id |
integer | No | 1.1 | Reference to OrderType |
order_channel |
string | No | 1.1 | Describes which unit (host) originated the order |
table_id |
integer | No | 1.0 | Reference to Table |
terminal_id |
integer | No | 1.0 | Reference to Terminal |
export_ref |
string | No | 1.0 | Export reference for external systems |
ready_time |
date | No | 1.0 | Ready time for order (pickup/delivery) |
discount_reason_id |
integer | No | 1.0 | Reference to discount reason |
refund_username |
string | No | 1.0 | Username who processed refund |
webshop_store_name |
string | No | 1.0 | Webshop store name |
receipt_type |
string | No | 1.0 | Receipt type identifier |
external_benefit_system_ident |
string | No | 1.1.1 | External benefit system identifier |
opened |
date | No | 1.0 | Order opened timestamp |
closed |
date | No | 1.0 | Order closed timestamp |
created_at |
date | No | 1.0 | Order creation timestamp |
closed_at |
date | No | 1.0 | Order closed timestamp |
cancelled_at |
date | No | 1.0 | Order cancellation timestamp |
Type Values
| Value | Description |
|---|---|
sales |
Standard sales order |
refund |
Refund/return transaction |
deposit |
Deposit payment |
invoice |
Invoice-based order |
internalsales |
Internal sales (staff, etc.) |
Example
{
"customer_id": 12345,
"name": "Table 5/1",
"type": "sales",
"revenue_unit_id": 101,
"revenue_unit_name": "Restaurant",
"order_type_id": 1,
"order_channel": "pos",
"table_id": 5,
"terminal_id": 3,
"export_ref": "EXP-2024-001234",
"ready_time": "2024-12-03T18:30:00Z",
"discount_reason_id": null,
"refund_username": null,
"webshop_store_name": null,
"receipt_type": "standard",
"external_benefit_system_ident": null,
"opened": "2024-12-03T18:00:00Z",
"closed": "2024-12-03T18:45:00Z",
"created_at": "2024-12-03T18:00:00Z",
"closed_at": "2024-12-03T18:45:00Z",
"cancelled_at": null
}