Retrieving Non-Exported Orders


When to Use

  • To retrieve orders previously not imported AND have marked previously imported orders as exported.

Important Considerations

  • Default value is 'false'.
  • Export status is set by each Developer Key and Integration Application ID and can be set and removed at will through the API.
  • The Application ID is unique by the Integration created in the Developer Console, so plan to mark orders as exported and retrieve orders from the same Integration to ensure the goal of avoiding retrieving already imported orders.
  • Export status is not viewable in the system user interface and is not a field on an item through the API
  • To test Export status on orders previously marked as exported=true, place a GET Orders request to retrieve orders without defining a specific Order ID. The orders marked as Exported should not be in the response.
  • Retrieving a specific order ID will always override the status, so this is not a valid way to test if Exported status has been set as coded.

Resource URL / Endpoint

GET https://api.channeladvisor.com/v1/Orders

Important and/or Required Parameters

PropertyRequiredNote
exportedRequiredInclude in URL. Query value will be true or false.
Note: there is no dollar sign ($) before this parameter. 
Example Request
GET https://api.channeladvisor.com/v1/Orders?access_token=xxxxxxxxxx&exported=false
Example Response (Success)
200 OK
{
  "@odata.context": "https://api.channeladvisor.com/v1/$metadata#Orders",
  "value": [
    {
      "ID": 19918546,
      "ProfileID": 12345678,
      "SiteID": 576,
      "SiteName": "eBay Fixed Price US",
      "SiteOrderID": "19918546",
      "SecondarySiteOrderID": "885689",
      "SellerOrderID": null,
		// Additional fields omitted to save space - all order data fields will appear
    },
	//...more orders
	"@odata.nextLink": "https://api.channeladvisor.com/v1/Orders?access_token=xxxxxxxxxx&$expand=Items,Fulfillments&exported=false&$skip=20"
}