| Name | Type | Description | Additional information |
|---|---|---|---|
| SiteId | integer |
Required |
|
| CustomerName | string |
Required String length: inclusive between 0 and 200 |
|
| Notes | string |
None. |
|
| OrderItems | Collection of Object |
Required |
|
| Promotions | Collection of CreateApiOrderPromoCommand |
Promotions are not currently supported |
|
| Discount | CreateApiOrderDiscountCommand |
A list of discounts for the bill. Items can be discounted individually on the item level or on the bill level. Discounts apply a negative tender against the bill |
|
| Tenders | Collection of CreateApiOrderTenderCommand |
Tenders for the bill, if tenders do not match the full bill amount the order will remain open on the POS and will not auto-finalize |
|
| BillNotes | string |
String length: inclusive between 0 and 10000 |
|
| KitchenMessage | string |
String length: inclusive between 0 and 10000 |
|
| WaiterMessage | string |
String length: inclusive between 0 and 10000 |
|
| CRMMemberID | integer |
Optional - send the Tevalis CRM Member ID that the order is for |
|
| ExternalMembershipID | string |
Optional - send the Non-Tevalis CRM Member ID that the order is for |
|
| SalesArea | string |
Optional - Specify the Sales Area for the Transaction |
|
| DeliveryTime | date |
Optional - a delivery time for the order. This works the same way as hold order at a site, and is based on table rules that are setup. E.g. order for tomorrow at 10pm, the order will sit in the system and fire 45minutes before this time (so at 9:15pm) and will then be sent to the kitchen etc and act like a normal order |
|
| PriceGroupID | integer |
Specify what pricegroup you're sending the order as |
|
| SCAmount | decimal number |
Tells the order what the service charge is. This will set the service charge to 0 if unspecified, to avoid the auto-service charge applying additional value to the bill |
|
| ThirdPartyReference | string |
Free text field to store the partner order reference |
|
| Terminal | string |
Unused field |
|
| ThirdPartyTransactionID | string |
Free text field to store the partner order ID |
|
| TableNumber | integer |
Optional - send the order to a table, table numbers are available through the floorplan endpoint |
|
| Gratuity | decimal number |
Specify if the bill contains gratuity/tip. This must be balanced by a Tender, e.g. £20 bill + £5 gratuity = £25 tender |
|
| OrderParams | string | ||
| CardSurchargeAmount | decimal number |
The extra amount charged for using the card |