Mark an Existing Fulfillment as Shipped


When to Use

  • Need to mark all items in a fulfillment as shipped.
    • See the Shipments page for more efficient methods of marking orders as shipped - ChannelAdvisor interprets the data provided through the Shipments methods to intelligently create fulfillments as needed.

Resource URL / Endpoint

PATCH or PUT https://api.channeladvisor.com/v1/Fulfillments(FulfillmentID)

Important and/or Required Parameters

PropertyRequiredNote
FulfillmentIDRequiredInclude in body. The ChannelAdvisor generated unique identifier for the Fulfillment.
DeliveryStatus*RequiredInclude 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 PATCH/PUT Fulfillment properties are optional to achieve the goal defined. Do not send FulfillmentItem properties or the request will fail.
Example Request
PATCH or PUT https://api.channeladvisor.com/v1/Fulfillments(123456)?access_token=xxxxxxxxxx
{ 
	"DeliveryStatus": "Complete",
	"TrackingNumber": "1Z 999 AA1 01 2345 6784",
	"ReturnTrackingNumber": "1Z395098NL993210K",
	"ShippedDateUtc": "2014-07-04T19:58:47.1Z"
}
Example Response (Success)
204 No Content