Mark an Entire Order as Shipped


When to Use

  • To mark an order as shipped - all items will be sent in the same box/tracking number sent in this request.
  • This is the most efficient way to send ChannelAdvisor shipping-related information.
  • This request will assume all items in this order will fall into the same tracking number - see the next section Mark an Order as Partially Shipped to only mark one item as shipped.

Resource URL / Endpoint

POST https://api.channeladvisor.com/v1/Orders(OrderID)/Ship

Important & Required Parameters

*If DeliveryStatus is not defined in a request, the order will be marked as shipped.

PropertyRequiredNote
OrderIDRequiredInclude in URL. The ChannelAdvisor generated unique identifier for the Order.
The Marketplace Order ID cannot be substituted here.
ShippedDateUtcOptionalInclude in body. Date/time (in UTC) the package was shipped. If no date/time is provided, ChannelAdvisor will set the current date/time when the request is received.
TrackingNumberOptionalInclude in body. Tracking number if available. Note: many marketplaces require this data, and require it to be valid to consider the order fulfilled.
ShippingCarrierOptionalInclude in body. Required if ShippingClass is sent. The Carrier that will be delivering the package - value must be in ChannelAdvisor's list of Account Shipping Carrier/Class Codes (note: custom values can be added).
ShippingClassOptionalInclude in body. Required if ShippingCarrier is sent. The Class of delivery for the package - value must be in ChannelAdvisor's list of Account Shipping Carrier/Class Codes (note: custom values can be added).
DeliveryStatusRequired*Include in body. See enum list of valid values under FulfillmentDeliveryStatus. Provides current status of shipment. Note: this is not linked to carrier data through the tracking number.
DistributionCenterIDOptionalInclude in body. If the item is shipped from a specific Distribution Center different from the one defined originally in the request, send the ID of that DC for data posterity.
Read more about Distribution Centers and accessing DistributionCenterIDs. 
Example Request
POST https://api.channeladvisor.com/v1/Orders(123456)/Ship?access_token=xxxxxxxxxx
{
  "Value":{
	"ShippedDateUtc": "2014-07-04T19:58:47.1Z",
    "TrackingNumber": "1Z 999 AA1 01 2345 6784",
    "SellerFulfillmentID": "AM-07-4423",
    "DistributionCenterID": 0,
    "DeliveryStatus": "Complete",
    "ShippingCarrier": "UPS",
    "ShippingClass": "Ground"
	}
}
Example Response (Success)
204 No Content