Mark Fulfillment as Shipped & Apply Shipping Costs


When to Use

  • To mark all items in a fulfillment as shipped, and apply a Tracking Number, Shipping Carrier, Shipping Class, and Shipping Cost data.
    • To split costs among items, follow direction on the pages to Create New Fulfillments and Move Fulfillments.

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.
ShippingCarrierRequiredInclude in body.
ShippingClassRequiredInclude in body.
ShippingCostRequiredInclude in body. Enter decimal value.
InsuranceCostRequiredInclude in body. Enter decimal value.
TaxCostRequiredInclude in body. Enter decimal value.
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(11560124)?access_token=xxxxxxxxxx
{
	"DeliveryStatus": "Complete",
	"TrackingNumber": "1Z12344595082049000",
	"ReturnTrackingNumber": "1Z395098NL993210K",
	"ShippingCarrier": "UPS",
	"ShippingClass": "Ground",
    "ShippingCost": 1.25,
    "InsuranceCost": 0.25,
    "TaxCost": 0.10
}
Example Response (Success)
204 No Content