GET orders?Downloaded={Downloaded}&ImportDateFrom={ImportDateFrom}&ImportDateTo={ImportDateTo}&OrderDateFrom={OrderDateFrom}&OrderDateTo={OrderDateTo}&WarehouseID={WarehouseID}&ChannelID={ChannelID}&OrderStatus={OrderStatus}&ChannelType={ChannelType}&ShippingMethodID={ShippingMethodID}&CompanyIdentityID={CompanyIdentityID}&ShippingTrackingNumber={ShippingTrackingNumber}&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

NameDescriptionTypeAdditional 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.
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. Types 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.
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
NameDescriptionTypeAdditional information
TotalItems integer None.
PagingInfo PagingFilter None.
TotalPages integer None.
PrevUrl string None.
PextUrl string 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": 0,
      "Channel": {
        "ChannelName": "Ebay UK",
        "ChannelType": "Ebay",
        "ChannelID": 1,
        "ChannelGuid": "626b199e-0258-40a1-9757-2245b91b8310",
        "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"
      },
      "ChannelShippingMethod": "Channel Shipping Method 1",
      "Weight": 0.0,
      "Currency": "GBP"
    }
  ]
}

application/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'application/xml'. Exception message: There was an error generating the XML document.

text/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'text/xml'. Exception message: There was an error generating the XML document.