Include Distribution Center Data (aka Expand Fulfillments)


When to Use

  • If quantity exists in multiple distribution centers (including, but not limited to Fulfillment by Amazon), this request provides information about which distribution center is recommended for shipment.

  • See more on all the options for filtering, querying, expanding data under the Getting and Filtering Data page

Resource URL / Endpoint

GET https://api.channeladvisor.com/v1/Orders?$expand=Fulfillments
GET https://api.channeladvisor.com/v1/Orders(OrderID)?$expand=Fulfillments

Important and/or Required Parameters

PropertyRequiredNote
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.
$expand=FulfillmentsRequiredInclude in the URL. Required to fulfill goal. Expands the Fulfillment level data in the order where the DistributionCenterID exists.
Example Request
GET https://api.channeladvisor.com/v1/Orders(19918546)?access_token=xxxxxxxxxx&$expand=Fulfillments
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": "1234",
      "SellerOrderID": null,
		// Additional fields omitted
      "Fulfillments": [
        {
          "ID": 11280613,
          "ProfileID": 12345678,
          "OrderID": 19918546,
          "CreatedDateUtc": "2016-02-12T14:54:39Z",
          "UpdatedDateUtc": "2016-02-12T14:52:41.077Z",
          "Type": "Ship",
          "DeliveryStatus": "NoChange",
          "TrackingNumber": null,
          "ShippingCarrier": "eBay",
          "ShippingClass": "Standard",
          "DistributionCenterID": 149,
		  "ExternalFulfillmentCenterCode": null,
          "ShippedDateUtc": null,
          "SellerFulfillmentID": null
        }
      ]
    }
}