Retail Kitchen Order
What one sale sent to the kitchen, ticket by ticket. Written by the till.
Area: Till sales · Why it is here: contract open_check · Fields: 8
iVendNext's own description: What one sale sent to the kitchen, ticket by ticket. Written by the till.
Read and write it
Every call runs as your app's own user, with its key in one header, at the retailer's own address. The user reads and writes only what its role allows: your app's user, and the rights the retailer gives it.
Read a list (only name unless you ask for fields):
curl -s "https://⟨site⟩/api/resource/Retail%20Kitchen%20Order?fields=%5B%22*%22%5D&limit_page_length=20" \
-H "Authorization: token ⟨api key⟩:⟨api secret⟩"
Read one, with its tables:
curl -s "https://⟨site⟩/api/resource/Retail%20Kitchen%20Order/⟨name⟩" -H "Authorization: token ⟨api key⟩:⟨api secret⟩"
Your app reads it; it does not write it here: the till writes it. All the record calls and their answers: the API reference.
Fields
Read from the product at POS 2.1.0.667 (till app 60147699c): its own fields, the fields iVendNext adds to it, and iVendNext's changes to any of them. Read-only fields are set by iVendNext; a hidden one is not on the form but can be read. Every record also has name (its id, in the address), owner, creation, modified, modified_by and docstatus (0 a draft, 1 submitted, 2 cancelled), all read-only.
| Field | Field name | Type | Required | Read-only | Hidden | Links to |
|---|---|---|---|---|---|---|
| Register | pos_profile |
Link | yes | POS Profile | ||
| Till | terminal |
Link | yes | POS Terminal | ||
| Sale | sale_ref |
Data | yes | |||
| Service Mode | service_mode |
Data | yes | |||
| Call Number | call_number |
Data | yes | |||
| Tickets | last_ticket |
Int | yes | |||
| Held Back | held_lines |
Long Text | yes | yes | ||
| Lines | lines |
Table | yes | Retail Kitchen Order Line |
Table: Retail Kitchen Order Line
The rows of lines. Each row also has idx (its place), parent, parentfield and parenttype.
| Field | Field name | Type | Required | Read-only | Hidden | Links to |
|---|---|---|---|---|---|---|
| Kind | kind |
Select | one of: Send, Void | |||
| Ticket | ticket |
Int | ||||
| Station | station |
Link | Retail Kitchen Station | |||
| Item | item_code |
Link | Item | |||
| Item Name | item_name |
Data | ||||
| Unit | uom |
Data | ||||
| Quantity | qty |
Float | ||||
| Note | note |
Small Text | ||||
| Option Of | option_of |
Small Text | ||||
| Line | signature |
Small Text | ||||
| State | state |
Select | one of: handed, agent, failed, window | |||
| Sent At | sent_at |
Datetime | ||||
| Sent By | sent_by |
Link | User | |||
| Offline mark | mark |
Data | yes | |||
| Check Line | check_line |
Data | yes |