| Name | Description | Type | Additional information |
|---|---|---|---|
| ShippingAmountNet |
The Shipping Value (exc. tax) |
decimal number |
None. |
| TillSystemVersion |
Optional. The version of the EPOS software used for the sale. Useful for fault tracking. |
integer |
None. |
| CustomerRequestedEReceipt |
The customer gave permission for their receipt to be sent via email. |
boolean |
Required |
| Items |
The products in the sale |
Collection of EskimoClassLibraries.clsSalesItemExt |
Required |
| Tenders |
The tenders used to pay for the sale. |
Collection of EskimoClassLibraries.clsTenderEntry |
Required |
| TotalOrder | decimal number |
None. |
|
| TillNumber |
From api/TillMenu/UnitInfo |
integer |
Required |
| ReceiptNumber |
Optional. If passed, this will be used, otherwise the next receipt number will be issued by the system. |
integer |
None. |
| StoreID |
Shop Code that the sale is assigned to. See api/Shops/All |
string |
Required String length: inclusive between 3 and 3 |
| ExternalIdentifier |
This is an optional secondary reference. |
string |
String length: inclusive between 0 and 200 |
| EskimoCustomerID |
The Eskimo Customer ID in the format 123-123456. |
string |
Matching regular expression pattern: \d{3}[-]\d{6} String length: inclusive between 10 and 10 |
| DatePlaced |
The date the customer placed the sale |
date |
Required |
| DeliveryDate |
Optional. Only applicable if items in the sale are marked to be ordered. This is the date the customer would like their order delivered. This could be specified because they are going on holiday and do not want delivery to occur until they return. |
date |
None. |
| InvoiceAddress |
The Invoice Address for any products ordered. Can be left null if irrevant or there are no changes to the address. If populated though, the address will either be added or updated where necessary |
EskimoClassLibraries.clsAddress |
None. |
| DeliveryAddress |
The Delivery Address for any products ordered. Can be left null if irrevant or there are no changes to the address. If populated though, the address will either be added or updated where necessary |
EskimoClassLibraries.clsAddress |
None. |
| ClickAndCollectShop |
Optional. If any of the items are for a sales channel that creates an order for a customer, this is the shop that the goods can be collected from. See api/Shops/All |
string |
String length: inclusive between 3 and 3 |
| InvoiceAddressRef |
When products are being ordered, this is the Address Reference for the Invoice Address. Defaults to 'MAIN' if not passed. |
string |
String length: inclusive between 1 and 12 |
| DeliveryAddressRef |
When products are being ordered, this is the Address Reference for the Delivery Address. |
string |
String length: inclusive between 1 and 12 |
| InvoiceFAO |
The person's name that will receive the invoice when items have been ordered. |
string |
None. |
| DeliveryFAO |
When items have been ordered, this is the name of the person that the parcel is destined for. Not necessarily the same as the customer making the purchase. |
string |
None. |
| CustomerReference |
Optional reference that the customer wants to refer to the order as. I.e. 'Presents for Debbie' |
string |
String length: inclusive between 0 and 30 |
| SaleNotes |
Any notes you need saved against the transaction |
string |
String length: inclusive between 0 and 400 |
| OrderNotes |
Free text order notes. i.e. 'Please ship all items in the same consignment.' (Only applicable if items with a CustomerAction > -1 are present.) |
string |
None. |
| DeliveryNotes |
Free text delivery notes. i.e. 'Please leave package in porch if no reply.' (Only applicable if items with a CustomerAction > -1 are present.) |
string |
None. |
| ShippingRateID |
The ID of the shipping rate used on the sale. See api/Orders/FulfilmentMethods. |
integer |
None. |
| ShippingAmountGross |
The Shipping Value (inc. tax) |
decimal number |
None. |
| OrderStatus |
Optional. If the sales channel of any of them items will generate an order, this field specifies the status of that order. See api/Orders/StatusCodes |
integer |
None. |
| SaleSourceID |
See SaleOptions.Sources in api/TillMenu/UnitInfo |
integer |
None. |
| CashDrawerID |
The ID of the clsHardwareItem class object that was used when firing the cash drawer. Pass null if the cash drawer was not fired |
integer |
None. |
| SourceCodeID |
Optional. If passed, it should match a CodeID from api/TillMenu/SourceCodes |
integer |
None. |
| CustomSourceCodeText |
Optional. If the operator has entered a new Source Code that is not present in the api/TillMenu/SourceCodes call, then this can be used to potentially create a new Source Code, if the setup has this behaviour enabled. |
string |
None. |
| OperatorID |
Optional. The Eskimo Operator ID of the person who performed the sale. If omitted, the operator 'SYSTEM' will be used. |
string |
None. |
| OrderIDs |
Optional. Only pass if the relevent order type has been pre-reserved via /api/TillMenu/SaleIDs |
Collection of EskimoClassLibraries.OrderIDs |
None. |