Order Retrieval with Emphasis on Site Account ID


About SiteAccountID

  • The SiteAccountID represents the unique ChannelAdvisor representation of a seller's account name at a marketplace.
  • A seller may have multiple accounts at a single marketplace (ie: eBay, Amazon) within the same locale, therefore this data helps provide a method to identify which account the order came through.
  • The SiteAccountID correlates with unique ID stored in the Profiles endpoint.
  • See the page on Retrieving Site Account Information within a profile.

When to Use

  • To request basic order information such as Order IDs, SiteAccountIDs, total order values, total order tax values, total order shipping values, payment/shipping status, buyer contact information, and buyer address information.
  • These examples are meant to highlight the SiteAccountID with context.

Suggested Workflow

  • As new marketplaces or seller accounts are added to a profile (or as a seller activates/deactivates marketplace accounts), request the list of profiles and expand the SiteAccounts collection.
  • Capture the SiteAccountID and SiteAccountName (at a minimum) for reference.
  • When requesting orders, cross reference the SiteAccountID from the order with the stored value to identify the SiteAccountName.

Resource URL / Endpoint

GET https://api.channeladvisor.com/v1/Orders
GET https://api.channeladvisor.com/v1/Orders(OrderID)

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.
OrderIDConditionalInclude in URL. Required to retrieve a specific order.
The ChannelAdvisor generated unique identifier for the Order.
When specifying the Order ID, the Profile ID is not needed since the Order ID will be unique across all profiles.

Sample Formats

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

  • This request will retrieve the order data for all available orders in the profile being queried.

GET https://api.channeladvisor.com/v1/Orders(108971)

  • This request will retrieve the order data for Order ID = 108971

Retrieve All Orders (No Filters)

Example Request
GET https://api.channeladvisor.com/v1/Orders?access_token=xxxxxxxxxx
Amazon Order Example Result (Success)
200 OK
{
    "@odata.context": "https://api.channeladvisor.com/v1/$metadata#Orders",
    "value": [
        {
            "ID": 9901234,
            "ProfileID": 98765432,
            "SiteID": 640,
            "SiteName": "Amazon Seller Central - US",
            "SiteAccountID": 5598,
            "SiteOrderID": "123-4567890-1234567",
            "SecondarySiteOrderID": null,
            "SellerOrderID": null,
            "CheckoutSourceID": null,
			// Omitted additional Order data to save space.
        }
		// Omitted additional Orders to save space.
	]
}
eBay Order Example Result (Success)
200 OK
{
    "@odata.context": "https://api.channeladvisor.com/v1/$metadata#Orders",
    "value": [
        {
            "ID": 986658,
            "ProfileID": 98765432,
            "SiteID": 576,
            "SiteName": "eBay Fixed Price US",
            "SiteAccountID": 8631,
            "SiteOrderID": "986658",
            "SecondarySiteOrderID": "321098765432-1098765432109",
            "SellerOrderID": null,
            "CheckoutSourceID": null,
            // Omitted additional Order data to save space.
        }
		// Omitted additional Orders to save space.
	]
}