| Name | Description | Type | Additional information |
|---|---|---|---|
| ChannelIDs |
A list of channel IDs that you want to see results for. Pass null to not filter |
Collection of integer |
None. |
| ShippingTypeIDs |
A list of shipping type IDs that you want to see results for. Pass null to not filter |
Collection of integer |
None. |
| CustomerID |
Optional. 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 |
| OrderNumber |
The Web Order ID or the Customer Order ID. Optional. |
integer |
None. |
| IncludeOrderItems |
Specifies whethere the order items should be included in the returned results or not. True if omitted |
boolean |
None. |
| HideOutOfStockOrderedItems |
With this option on, orders will still be included in the results if there is items that don't have sufficient stock, but those items will not be included. |
boolean |
None. |
| HideOrdersWithOutOfStockItems |
If any ordered products on an order are out of stock, don't return that order in the results as it cannot be completely processed by a dispatch team. |
boolean |
None. |