NameDescriptionTypeAdditional information
ExternalIdentifier

Search for orders that matching this external reference given when inserting the order.

string

None.

FromDate

Return orders greater than this date/time

date

Required

ToDate

Return orders earlier than this date/time

date

Required

OrderType

The type of orders to return. The ChannelID, see api/Sales/Channels

integer

Required

IncludeCustomerDetails

If only the Eskimo Customer ID is required, then pass false, otherwise pass true and more information about the customer will be included in the CustomerInfo field.

boolean

Required

IncludeProductDetails

If only the Header information is required, then pass false, otherwise pass true and more information about the ordered items will be included in the OrderedItems field.

boolean

Required

CustomerID

The unique ID of the customer. This is in the format 000-000000 where the first three digits represent the Shop/Showroom code.

string

Matching regular expression pattern: \d{3}[-]\d{6}

String length: inclusive between 10 and 10

StoreNumber

The Code of the shop the order is assigned to. See api/Shops/All

string

String length: inclusive between 0 and 3