Retrieve Existing Fulfillments


When to Use

  • To request the Fullfillment data on an order.
    • Note: the more common way to obtain this data is at the time orders are retrieved and expand the fulfillment data in the same request - see Advanced Order Retrievals.
  • To get specific information from a single Fulfillment in the API.
  • See more about filtering, querying, expanding data under the Getting and Filtering Data page.

Resource URL / Endpoint

GET  https://api.channeladvisor.com/v1/Fulfillments
GET https://api.channeladvisor.com/v1/Fulfillments(FulfillmentID)

Important and/or Required Parameters

PropertyRequiredNote
FulfillmentIDConditional

Include in URL. The ChannelAdvisor generated unique identifier for the Fulfillment.
Only required if retrieving a specific fulfillment.
Omit if retrieving all fulfillments.

Retrieving Fulfillments (High Level)

Example Request
GET https://api.channeladvisor.com/v1/Fulfillments?access_token=xxxxxxxxxx
Example Response (Success)
200 OK
{
  "@odata.context": "https://api.channeladvisor.com/v1/$metadata#Fulfillments",
  "value": [
		{
		"ID": 11188712,
		"ProfileID": 12345678,
		"OrderID": 19828003,
		"CreatedDateUtc": "2015-08-07T13:51:29.68Z",
		"UpdatedDateUtc": "2015-08-07T14:33:14.02Z",
		"Type": "Ship",
		"DeliveryStatus": "NoChange",
		"TrackingNumber": null,
		"ShippingCarrier": "UPS",
		"ShippingClass": "Ground",
		"DistributionCenterID": 192,
		"ExternalFulfillmentCenterCode": null,
		"ShippedDateUtc": null,
		"SellerFulfillmentID": null
		},
		{
		"ID": 11188716,
		"ProfileID": 12345678,
		"OrderID": 19828007,
		"CreatedDateUtc": "2015-08-07T14:05:34.393Z",
		"UpdatedDateUtc": "2015-08-07T14:05:36.33Z",
		"Type": "Ship",
		"DeliveryStatus": "NoChange",
		"TrackingNumber": null,
		"ShippingCarrier": null,
		"ShippingClass": null,
		"DistributionCenterID": 192,
		"ExternalFulfillmentCenterCode": null,
		"ShippedDateUtc": null,
		"SellerFulfillmentID": null
		}
	]
}

Retrieving Fulfillments that are Fulfilled by Amazon

Example Request
GET https://api.channeladvisor.com/v1/Fulfillments?access_token=xxxxxxxxxx
Example Response (Success)
200 OK
{
  "@odata.context": "https://api.channeladvisor.com/v1/$metadata#Fulfillments",
  "value": [
		{
		"ID": 691704,
		"ProfileID": 12024974,
		"OrderID": 765635,
		"CreatedDateUtc": "2017-06-13T19:45:17Z",
		"UpdatedDateUtc": "2017-06-14T11:56:53.34Z",
		"Type": "Ship",
		"DeliveryStatus": "Complete",
		"TrackingNumber": "TBA123456789012",
		"ShippingCarrier": "AMZN_US",
		"ShippingClass": "Expedited",
		"DistributionCenterID": -2,
		"ExternalFulfillmentCenterCode": "IND4 ",
		"ShippedDateUtc": "2017-06-14T08:37:10Z",
		"SellerFulfillmentID": "G6G1ijKLM"
		},
		{
		"ID": 11188712,
		"ProfileID": 12345678,
		"OrderID": 19828003,
		"CreatedDateUtc": "2017-02-07T13:51:29.68Z",
		"UpdatedDateUtc": "2017-02-07T14:33:14.02Z",
		"Type": "Ship",
		"DeliveryStatus": "Complete",
		"TrackingNumber": "TBA987654312098",
		"ShippingCarrier": "AMZN_US",
		"ShippingClass": "Expedited",
		"DistributionCenterID": -2,
		"ExternalFulfillmentCenterCode": "CLD2 ",
		"ShippedDateUtc": null,
		"SellerFulfillmentID": "A1A1bcDEF"
		},
	]
}

Retrieving Specific Fulfillment with Item Information

Example Request
GET https://api.channeladvisor.com/v1/Fulfillments(11371753)?access_token=xxxxxxxxxx&$expand=Items
Example Response (Success)
200 OK
{
  "@odata.context": "https://api.channeladvisor.com/v1/$metadata#Fulfillments/$entity",
  "ID": 11371753,
  "ProfileID": 12345678,
  "OrderID": 20008076,
  "CreatedDateUtc": "2016-07-27T18:59:57.117Z",
  "UpdatedDateUtc": "2016-07-27T19:00:11.72Z",
  "Type": "Ship",
  "DeliveryStatus": "NoChange",
  "TrackingNumber": null,
  "ShippingCarrier": "eBay",
  "ShippingClass": "First Class",
  "DistributionCenterID": 149,
  "ExternalFulfillmentCenterCode": null,
  "ShippedDateUtc": null,
  "SellerFulfillmentID": null,
  "Items": [
    {
      "ID": 7384602,
      "ProfileID": 12345678,
      "FulfillmentID": 11371753,
      "OrderID": 20008076,
      "OrderItemID": 22328371,
      "Quantity": 1,
      "ProductID": 25030238
    },
    {
      "ID": 7384603,
      "ProfileID": 12345678,
      "FulfillmentID": 11371753,
      "OrderID": 20008076,
      "OrderItemID": 22328372,
      "Quantity": 2,
      "ProductID": 25398133
    }
  ]
}

Retrieving Specific Fulfillment with Item Information Only Knowing Order ID

Example Request
GET https://api.channeladvisor.com/v1/Fulfillments?access_token=xxxxxxxxxx&$filter=OrderID eq 20008076&$expand=Items
Example Response (Success)
200 OK
{
  "@odata.context": "https://api.channeladvisor.com/v1/$metadata#Fulfillments/$entity",
  "ID": 11371753,
  "ProfileID": 12345678,
  "OrderID": 20008076,
  "CreatedDateUtc": "2016-07-27T18:59:57.117Z",
  "UpdatedDateUtc": "2016-07-27T19:00:11.72Z",
  "Type": "Ship",
  "DeliveryStatus": "NoChange",
  "TrackingNumber": null,
  "ShippingCarrier": "eBay",
  "ShippingClass": "First Class",
  "DistributionCenterID": 149,
  "ExternalFulfillmentCenterCode": null,
  "ShippedDateUtc": null,
  "SellerFulfillmentID": null,
  "Items": [
    {
      "ID": 7384602,
      "ProfileID": 12345678,
      "FulfillmentID": 11371753,
      "OrderID": 20008076,
      "OrderItemID": 22328371,
      "Quantity": 1,
      "ProductID": 25030238
    },
    {
      "ID": 7384603,
      "ProfileID": 12345678,
      "FulfillmentID": 11371753,
      "OrderID": 20008076,
      "OrderItemID": 22328372,
      "Quantity": 2,
      "ProductID": 25398133
    }
  ]
}