Basic Order Retrieval Requests


When to Use

  • To retrieve basic order information, such as Order IDs, total order values, total order tax values, total order shipping values, payment/shipping status, buyer contact information, and buyer address information.
  • This basic request will exclude item-level information such as SKUs included in the order, individual item-level quantities ordered, etc.
  • Note the ability to skip pages at the bottom of this example - this is the type of URL that can be used to move to the next 20 orders resulting from this request.

Resource URL / Endpoint

GET https://api.channeladvisor.com/v1/Orders
GET https://api.channeladvisor.com/v1/Orders(OrderID)
GET https://api.channeladvisor.com/v1/Orders?$filter=ProfileID eq ProfileID

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

GET https://api.channeladvisor.com/v1/Orders?$filter=ProfileID eq 12345678 

  • This request will retrieve the order data for Profile ID = 12345678

Retrieve All Orders (No Filters)

Example Request
GET https://api.channeladvisor.com/v1/Orders?access_token=xxxxxxxxxx
Example Result (Success)
200 OK
{
  "@odata.context": "https://api.channeladvisor.com/v1/$metadata#Orders",
  "value": [
    {
      "ID": 25273704,
      "ProfileID": 12345678,
      "SiteID": 930,
      "SiteName": "Jet",
      "SiteOrderID": "125977339633",
      "SecondarySiteOrderID": "2ab4557edee54641b4547dc817890ee6",
      "SellerOrderID": null,
      "CheckoutSourceID": null,
      "CreatedDateUtc": "2016-09-25T23:47:03Z",
      "ImportDateUtc": "2016-09-26T03:42:30.947Z",
      "PublicNotes": null,
      "PrivateNotes": "Base - Base - $102.00",
      "SpecialInstructions": "",
      "TotalPrice": 1699.99,
      "TotalTaxPrice": 0,
      "TotalShippingPrice": 0,
      "TotalShippingTaxPrice": null,
      "TotalInsurancePrice": 0,
      "TotalGiftOptionPrice": 0,
      "TotalGiftOptionTaxPrice": null,
      "AdditionalCostOrDiscount": 0,
      "EstimatedShipDateUtc": null,
      "DeliverByDateUtc": null,
      "ResellerID": null,
      "FlagID": 0,
      "FlagDescription": null,
      "OrderTags": null,
      "DistributionCenterTypeRollup": "SellerManaged",
      "CheckoutStatus": "Completed",
      "PaymentStatus": "Cleared",
      "ShippingStatus": "Unshipped",
      "CheckoutDateUtc": "2016-02-29T12:43:19Z",
      "PaymentDateUtc": "2016-02-29T12:43:19Z",
      "ShippingDateUtc": "2016-03-01T04:45:26.21Z",
      "BuyerUserId": "jonathan.doe.jet.447094560291@example.com",
      "BuyerEmailAddress": "jonathan.doe.jet.447094560291@example.com",
      "BuyerEmailOptIn": false,
      "OrderTaxType": "Standard",
      "ShippingTaxType": "Standard",
      "GiftOptionsTaxType": "Standard",
      "PaymentMethod": "Jet",
      "PaymentTransactionID": null,
      "PaymentPaypalAccountID": null,
      "PaymentCreditCardLast4": "",
      "PaymentMerchantReferenceNumber": null,
      "ShippingTitle": null,
      "ShippingFirstName": "Jonathan",
      "ShippingLastName": "Doe",
      "ShippingSuffix": "Sr",
      "ShippingCompanyName": null,
      "ShippingCompanyJobTitle": null,
      "ShippingDaytimePhone": "1234567890",
      "ShippingEveningPhone": null,
      "ShippingAddressLine1": "45 Main Street",
      "ShippingAddressLine2": "",
      "ShippingCity": "Stevens",
      "ShippingStateOrProvince": "PA",
      "ShippingPostalCode": "17578",
      "ShippingCountry": "US",
      "BillingTitle": null,
      "BillingFirstName": "Jonathan",
      "BillingLastName": "Doe",
      "BillingSuffix": "Sr",
      "BillingCompanyName": "",
      "BillingCompanyJobTitle": null,
      "BillingDaytimePhone": "1234567890",
      "BillingEveningPhone": null,
      "BillingAddressLine1": "45 Main Street",
      "BillingAddressLine2": "",
      "BillingCity": "Stevens",
      "BillingStateOrProvince": "PA",
      "BillingPostalCode": "17578",
      "BillingCountry": "US",
      "PromotionCode": null,
      "PromotionAmount": 0
    },
    {
		// Omitted additional Orders to save space.
    }
  ],
  "@odata.nextLink": "https://api.channeladvisor.com/v1/Orders?access_token=xxxxxxxxxx&$skip=20"
}