Create a New Fulfillment & Mark as Shipped


When to Use & Considerations

  • To ship items in the same Order with different tracking number or different carrier/classes, create a new fulfillment first.
    • Cannot create a New Fulfillment and define an existing product to be moved to that Fulfillment in the same request (the new Fulfillment ID is provided within the response for the request below).
    • See Move Entire Fulfillment Into New Fulfillment
  • Optionally mark the fulfillment as shipped while creating the fulfillment, or make a separate request to do so - the example below marks the order as shipped, but also includes other optional properties.
  • See the more efficient methods under Shipments section. ChannelAdvisor can create new Fulfillments intelligently through that methodology.

Resource URL / Endpoint

POST https://api.channeladvisor.com/v1/Fulfillments

Important and/or Required Parameters

PropertyRequiredNote
OrderIDRequiredInclude in body. The ChannelAdvisor generated unique identifier for the Order.
ProfileIDRequiredInclude in body. The ChannelAdvisor Profile ID identifying the profile - required when authorization covers multiple profiles.
DeliveryStatusRequiredInclude in body. See enum values for FulfillmentDeliveryStatus. Required to achieve goal.
Any value other than 'NoChange' will be treated as final status for the order.
TrackingNumberOptionalInclude in body. Provided by a shipping carrier to track the progress of a shipment.
While technically optional, many marketplaces require this data, and require it to be valid to consider the order fulfilled.
ReturnTrackingNumberOptionalInclude in body. Provided by a shipping carrier to track the progress of a return shipment.
While technically optional, many marketplaces require this data while marking the order as shipped, and require it to be valid to consider the order fulfilled.
All other Fulfillment properties are optional to achieve the goal defined. Do not send FulfillmentItem properties or the request will fail.
Example Request
POST https://api.channeladvisor.com/v1/Fulfillments?access_token=xxxxxxxxxx
{
    "OrderID": 4445862222,
	"ProfileID": 12345678,
	"DeliveryStatus": "Complete",
    "TrackingNumber": "12 34 56 78 91 01 11 21",
	"ReturnTrackingNumber": "1Z395098NL993210K",
	"ShippingCarrier": "UPS",
	"ShippingClass": "Standard",
    "SellerFulfillmentID": "TestFulfillmentID",
}
Example Response (Success)
201 Created
{
  "@odata.context": "https://api.channeladvisor.com/v1/$metadata#Fulfillments/$entity",
  "ID": 11290702,
  "ProfileID": 12345678,
  "OrderID": 4445862222,
  "CreatedDateUtc": "2016-03-02T19:58:47.51Z",
  "UpdatedDateUtc": "2016-03-02T19:58:47.607Z",
  "Type": "Ship",
  "DeliveryStatus": "Complete",
  "TrackingNumber": "12 34 56 78 91 01 11 21",
  "ReturnTrackingNumber": "1Z395098NL993210K",
  "ShippingCarrier": "UPS",
  "ShippingClass": "Standard",
  "DistributionCenterID": 0,
  "ShippedDateUtc": null,
  "SellerFulfillmentID": "TestFulfillmentID"
}