| Name | Description | Type | Additional information |
|---|---|---|---|
| ShopID | string |
String length: inclusive between 0 and 3 |
|
| HasOtherOrders | boolean |
None. |
|
| CustomerInfo | EskimoClassLibraries.clsCustomer |
None. |
|
| WebOrderID | integer |
None. |
|
| TotalQtyProcessed | integer |
None. |
|
| OrderItemQty | integer |
None. |
|
| order_id |
The numerical ID of the order. This is not an Eskimo ID, but rather the ID generated by website/cart. |
integer |
Range: inclusive between 0 and 2147483647 |
| ExternalIdentifier |
This is an optional secondary reference. Some references are text-based and therefore cannot be inserted into the order_id field. If omitted, a GUID will be assigned. |
string |
String length: inclusive between 0 and 200 |
| OrderType |
The sales channel of the order being inserted. See api/Sales/Channels |
integer |
Required |
| eskimo_customer_id |
The Eskimo Customer ID in the format 123-123456. |
string |
Required Matching regular expression pattern: \d{3}[-]\d{6} String length: inclusive between 10 and 10 |
| order_date |
The date the customer placed the order |
date |
Required |
| invoice_amount |
The total value of the order. (A sum of the OrderedItems plus the Carriage) |
decimal number |
Required |
| amount_paid |
The amount of the order that has been paid. |
decimal number |
Required |
| order_discount |
The sum of any order level discounts. As Eskimo does not have an order-level discount, this amount will be evenly applied to each product line |
decimal number |
None. |
| DeliveryAddress |
Exclude if equal to the invoice address |
EskimoClassLibraries.clsOrderAddressInfo |
None. |
| InvoiceAddress | EskimoClassLibraries.clsOrderAddressInfo |
Required |
|
| OrderedItems |
All the items the customer purchased |
Collection of Web_API.clsUnfulfilledOrderItem |
Required |
| 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 |
| OrderNotes |
Free text general notes. |
string |
None. |
| DeliveryNotes |
Free text delivery notes. i.e. 'Please leave package in porch if no reply.' |
string |
None. |
| ShippingRateID |
The ID of the shipping rate used on the order. See api/Orders/FulfilmentMethods |
integer |
Required |
| ShippingAmountGross |
The Shipping Value (inc. tax) |
decimal number |
Required |
| CustomerAccountValuePaid |
If the client is offering a saving scheme to their customers, this field can be used to reduce the customer's balanace by the amount provided, whilst linking that reduction with this order. |
decimal number |
Range: inclusive between 0 and 7.92281625142643E+28 |