GET orders?Downloaded={Downloaded}&ImportDateFrom={ImportDateFrom}&ImportDateTo={ImportDateTo}&LastStatusChangeDateFrom={LastStatusChangeDateFrom}&LastStatusChangeDateTo={LastStatusChangeDateTo}&OrderDateFrom={OrderDateFrom}&OrderDateTo={OrderDateTo}&WarehouseID={WarehouseID}&ChannelID={ChannelID}&OrderStatus={OrderStatus}&ChannelType={ChannelType}&ShippingMethodID={ShippingMethodID}&CompanyIdentityID={CompanyIdentityID}&ShippingTrackingNumber={ShippingTrackingNumber}&ChannelOrderRef={ChannelOrderRef}&PageSize={PageSize}&Page={Page}
Get orders call. Allows multiple different filters. A common usage would be to filter by downloaded=false and orderStatusId=3 3 is complete read to pick. This would provide you with all orders which have not been marked as downloaded and are ready to be shipped.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| Downloaded | This is an optional parameter. Set it to false to only return orders which have not been marked as downloaded | boolean | None. |
| ImportDateFrom | This is an optional parameter. Set this to get orders with an Import date more than or equal to the provided date for instance: 2016-05-01T00:00:00Z This must be specified in UTC time | date | None. |
| ImportDateTo | This is an optional parameter. Set this to get orders with an Import date less than or equal to the provided date for instance: 2016-06-01T00:00:00Z This must be specified in UTC time | date | None. |
| LastStatusChangeDateFrom | This is an optional parameter. Set this to get orders with an Last Status Change date more than or equal to the provided date for instance: 2016-05-01T00:00:00Z This must be specified in UTC time | date | None. |
| LastStatusChangeDateTo | This is an optional parameter. Set this to get orders with an Last Status Change date less than or equal to the provided date for instance: 2016-06-01T00:00:00Z This must be specified in UTC time | date | None. |
| OrderDateFrom | This is an optional parameter. Set this to get orders with an Order date more than or equal to the provided date for instance: 2016-05-01T00:00:00Z This must be specified in UTC time | date | None. |
| OrderDateTo | This is an optional parameter. Set this to get orders with an Order date less than or equal to the provided date for instance: 2016-06-01T00:00:00Z. This must be specified in UTC time | date | None. |
| WarehouseID | This is an optional parameter. Set it to only return orders for a given warheouse. You can get a list of warehouses from the warehouses endpoint. | integer | Matching regular expression pattern: ^[1-9]\d*$ |
| ChannelID | This is an optional parameter. Set it to only return orders for a given channel. You can get a list of channels from the channels endpoint. | integer | Matching regular expression pattern: ^[1-9]\d*$ |
| OrderStatus | This is an optional parameter.Set it only return orders of a given status.You can get a list of status codes from the OrderStatus endpoint. | Statuses | None. |
| ChannelType | This is an optional parameter. Set it only return orders of a given Channel Type for instance: Ebay, Amazon,Big Commerce. You can get a list of Channel Types from the ChannelType endpoint. | ChannelType | None. |
| ShippingMethodID | This is an optional parameter. Set it only return orders of a given Shipping Method. You can get a list of Shipping Method IDs from the Shipping Methods endpoint. | integer | Matching regular expression pattern: ^[1-9]\d*$ |
| CompanyIdentityID | This is an optional parameter. Set it only return orders of a given Company Identitiy. You can get a list of Company Identity IDs from the Company Identity endpoint. | integer | Matching regular expression pattern: ^[1-9]\d*$ |
| ShippingTrackingNumber | This is an optional parameter. Set it to only return orders with the specified tracking number. | string | None. |
| ChannelOrderRef | This is an optional parameter. Set it to only return orders with the specified Channel Order Ref. | string | None. |
| PageSize | This is an optional parameter. This will default to 100. The max page size is 100 | integer | Range: inclusive between 1 and 100 |
| Page | This is an optional parameter. It will default to page 1. | integer | Matching regular expression pattern: ^[1-9]\d*$ |
Body Parameters
None.
Response Information
Resource Description
Get orders call. Allows multiple different filters. A common usage would be to filter by downloaded=false and orderStatusId=3 3 is complete read to pick. This would provide you with all orders which have not been marked as downloaded and are ready to be shipped.
PagedResponseModelOfOrderModel| Name | Description | Type | Additional information |
|---|---|---|---|
| TotalItems | integer | None. | |
| PagingInfo | PagingFilter | None. | |
| TotalPages | integer | None. | |
| Data | Collection of OrderModel | None. |
Response Formats
application/json, text/json
Sample:
{
"TotalItems": 10,
"PagingInfo": {
"PageSize": 1,
"Page": 1
},
"TotalPages": 10,
"Data": [
{
"OrderNumber": 21345,
"OrderGuid": "00000000-0000-0000-0000-000000000000",
"OrderStatus": "AwaitingPayment",
"Channel": {
"ChannelName": "Ebay UK",
"ChannelType": "Ebay",
"ChannelID": 1,
"ChannelGuid": "a08a1ab7-4b4e-4ec4-8636-9f50241d6d97",
"IsActive": false
},
"ChannelOrderRef": "ORD200001",
"BillingAddress": {
"FirstName": "John",
"LastName": "Smith",
"Company": "Company name",
"Address1": "the cottage",
"Address2": "1 street name",
"Suite": "Suite Name",
"City": "City",
"State": "State",
"Postcode": "NG7 2RR",
"Country": "United Kingdom",
"PhoneNumber": "01234123456"
},
"IsPrime": false,
"IsPriority": false,
"IsAmazonBusiness": false,
"ChannelShippingMethod": "Channel Shipping Method 1",
"Weight": 0.0,
"Currency": "GBP",
"TaxExternallyCollected": false
}
]
}
application/xml, text/xml
Sample:
<PagedOrderModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<TotalItems>10</TotalItems>
<PagingInfo>
<PageSize>1</PageSize>
<Page>1</Page>
</PagingInfo>
<TotalPages>10</TotalPages>
<Data>
<OrderModel>
<OrderNumber>21345</OrderNumber>
<OrderGuid>00000000-0000-0000-0000-000000000000</OrderGuid>
<OrderStatus>AwaitingPayment</OrderStatus>
<Currency>GBP</Currency>
<Channel>
<ChannelName>Ebay UK</ChannelName>
<ChannelType>Ebay</ChannelType>
<ChannelID>1</ChannelID>
<ChannelGuid>a08a1ab7-4b4e-4ec4-8636-9f50241d6d97</ChannelGuid>
<IsActive>false</IsActive>
</Channel>
<ChannelOrderRef>ORD200001</ChannelOrderRef>
<ParentOrderNumber xsi:nil="true" />
<BillingAddress>
<FirstName>John</FirstName>
<LastName>Smith</LastName>
<Company>Company name</Company>
<Address1>the cottage</Address1>
<Address2>1 street name</Address2>
<Suite>Suite Name</Suite>
<City>City</City>
<State>State</State>
<Postcode>NG7 2RR</Postcode>
<Country>United Kingdom</Country>
<PhoneNumber>01234123456</PhoneNumber>
</BillingAddress>
<OrderDate xsi:nil="true" />
<AttentionIsRequired xsi:nil="true" />
<IsPrime>false</IsPrime>
<IsPriority>false</IsPriority>
<IsAmazonBusiness>false</IsAmazonBusiness>
<ImportDate xsi:nil="true" />
<ShipByDate xsi:nil="true" />
<DespatchDate xsi:nil="true" />
<DespatchSentToChannelDate xsi:nil="true" />
<DespatchOnChannelDate xsi:nil="true" />
<LastStatusChangeDate xsi:nil="true" />
<ChannelShippingMethod>Channel Shipping Method 1</ChannelShippingMethod>
<Weight>0</Weight>
<NumberOfPackages xsi:nil="true" />
<PickwaveID xsi:nil="true" />
<ExchangeRate xsi:nil="true" />
<CancelledDateUTC xsi:nil="true" />
<TaxExternallyCollected>false</TaxExternallyCollected>
</OrderModel>
</Data>
</PagedOrderModel>