Site Name and Order IDs Only for Non-Exported Orders


When to Use

  • To retrieve the ChannelAdvisor generated Order IDs, Site Name, and Marketplace Order IDs (both of them if applicable) in the response for orders that not yet imported.

  • Requires use of the Exported status - see Exported & Non-Exported Orders to learn more.
  • See more on all the options for filtering, querying, expanding data under the Getting and Filtering Data page.

  • For marketplace specific response data, see the Marketplace-Specific Order Responses for more information when building out an integration.

Resource URL / Endpoint

GET https://api.channeladvisor.com/v1/Orders?exported=false&$select=ID,SiteName,SiteOrderID,SecondarySiteOrderID

Important and/or Required Parameters

PropertyRequiredNote
ProfileIDConditionalInclude in URL. Required if need to only retrieve orders from a single profile when authorized for multiple profiles.
The ChannelAdvisor generated unique identifier for the Profile.
Replace value with numeric integer representing the ID.
exported=falseRequiredRequired to fulfill goal. Include in URL to retrieve non-exported orders.
$select=ID,SiteName,SiteOrderID,SecondarySiteOrderIDRequiredRequired to fulfill goal. Include in URL to require that the response returns the ID (ChannelAdvisor Order ID), Site Name, Site Order ID, and Secondary Site Order ID.
 
Other important/required parameters vary widely based on goals. Use Order Entities page to help guide what properties are available for filtering.
Example Request
GET https://api.channeladvisor.com/v1/Orders?access_token=xxxxxxxxxx&exported=false&$select=ID,SiteName,SiteOrderID,SecondarySiteOrderID
Example Response (Success)
200 OK
{
  "@odata.context": "https://api.channeladvisor.com/v1/$metadata#Orders(ID,SiteName,SiteOrderID,SecondarySiteOrderID)",
  "value": [
    {
      "ID": 19918546,
      "SiteName": "eBay Fixed Price US",
      "SiteOrderID": "19918546",
      "SecondarySiteOrderID": "666668555555-777777333322"
    },
    {
      "ID": 19918552,
      "SiteName": "eBay Fixed Price US",
      "SiteOrderID": "19918552",
      "SecondarySiteOrderID": "666668555555-777777333321"
    },
    {
      "ID": 19931767,
      "SiteName": "Amazon Marketplace",
      "SiteOrderID": "351-4367279-6214272",
      "SecondarySiteOrderID": null
    },
    {
      "ID": 19968657,
      "SiteName": "MercadoLibre CBT",
      "SiteOrderID": "b49d4978-07c1-43bd-aef1-0f253025d045",
      "SecondarySiteOrderID": null
    },
    {
      "ID": 19974070,
      "SiteName": "Jet",
      "SiteOrderID": "JetTestOrder-0000",
      "SecondarySiteOrderID": null
    },
    {
      "ID": 19975253,
      "SiteName": "Jet",
      "SiteOrderID": "NewTestOrderID-Jet5.27.16.10.35am",
      "SecondarySiteOrderID": null
    },
    {
      "ID": 19980710,
      "SiteName": "Amazon Seller Central - US",
      "SiteOrderID": "7e560ff9-8e71-4cf2-96a5-69b3457de119",
      "SecondarySiteOrderID": null
    },
    {
      "ID": 19980711,
      "SiteName": "Amazon Seller Central - US",
      "SiteOrderID": "44d2bc48-93b5-4bf1-89c4-8e4cff203a09",
      "SecondarySiteOrderID": null
    },
    {
      "ID": 19980712,
      "SiteName": "Amazon Seller Central - US",
      "SiteOrderID": "765-1664703-6041950",
      "SecondarySiteOrderID": null
    },
    {
      "ID": 19980713,
      "SiteName": "Amazon Merchants@",
      "SiteOrderID": "15efcf12-541f-4c0c-97fd-cc0d930978eb",
      "SecondarySiteOrderID": null
    },
    {
      "ID": 19980714,
      "SiteName": "Amazon Seller Central - US",
      "SiteOrderID": "311-5966965-5500553",
      "SecondarySiteOrderID": null
    },
    {
      "ID": 19980715,
      "SiteName": "Amazon Seller Central - US",
      "SiteOrderID": "264-4053178-7140253",
      "SecondarySiteOrderID": null
    },
    {
      "ID": 19980723,
      "SiteName": "Amazon Seller Central - US",
      "SiteOrderID": "11111111111A4B",
      "SecondarySiteOrderID": null
    },
    {
      "ID": 19980728,
      "SiteName": "Amazon Seller Central - US",
      "SiteOrderID": "11111111111A5B",
      "SecondarySiteOrderID": null
    },
    {
      "ID": 19980732,
      "SiteName": "Amazon Seller Central - US",
      "SiteOrderID": "11111111111A6B",
      "SecondarySiteOrderID": null
    },
    {
      "ID": 19988881,
      "SiteName": "Amazon UK",
      "SiteOrderID": "3f5a504f-d497-4e9b-a674-4b7770668a82",
      "SecondarySiteOrderID": null
    },
    {
      "ID": 19988883,
      "SiteName": "Amazon UK",
      "SiteOrderID": "270-3895839-9919950",
      "SecondarySiteOrderID": null
    },
    {
      "ID": 19988884,
      "SiteName": "Amazon UK",
      "SiteOrderID": "894-2403774-1166457",
      "SecondarySiteOrderID": null
    },
    {
      "ID": 19988885,
      "SiteName": "Amazon UK",
      "SiteOrderID": "366-1973673-0396212",
      "SecondarySiteOrderID": null
    },
    {
      "ID": 19988886,
      "SiteName": "Amazon UK",
      "SiteOrderID": "730-9758392-5301074",
      "SecondarySiteOrderID": null
    }
  ],
  "@odata.nextLink": "https://api.channeladvisor.com/v1/Orders?access_token=xxxxxxxxxx&exported=false&$select=ID%2CSiteName%2CSiteOrderID%2CSecondarySiteOrderID&$skip=20"
}