Mark an Order as Partially Shipped


When to Use

  • To mark part of an order as shipped.
  • This is the most efficient way to send ChannelAdvisor partial shipping information.
  • This request will assume only the item defined is being shipped and will be tied to the tracking information provided.
  • If there are other items in the order, the API will know items not included in this request will be outstanding - the order will be considered "Partially Shipped" until all items have been satisfied with shipping or cancellation requests.

Resource URL / Endpoint

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

Important & Required Parameters

*Required to mark the order 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.
SellerFulfillmentIDOptionalInclude in body. Identifier provided by the seller. Amazon only allows integers.
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. 
Items [OrderItemID]ConditionalInclude in body. OrderItemID or ProductID or Sku is required if the Items collection is included in a POST request. Identifies the item by Order Item ID.
Items [ProductID]ConditionalInclude in body. OrderItemID or ProductID or Sku is required if the Items collection is included in a POST request. Identifies the item by Product ID.
Items [Sku]ConditionalInclude in body. OrderItemID or ProductID or Sku is required if the Items collection is included in a POST request. Identifies the Sku (as defined by the seller).
Items [Quantity]ConditionalInclude in body. Required if the Items collection is included in a POST request, Quantity is required. If Items collection is excluded, Quantity is not required.
Items [SellerFulfillmentItemID]OptionalInclude in body. Identifier provided by the seller. Usually a serial number or batch number.

Single Shipment, Single Product

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": "FooBar",
    "DistributionCenterID": 0,
    "DeliveryStatus": "Complete",
    "ShippingCarrier": "UPS",
    "ShippingClass": "Ground",
    "Items":[
    {
      "Sku":"ABC",
      "Quantity":1,
	  "SellerFulfillmentItemID": "Batch-453823251574896"
    }]
  }
}
Example Response (Success)
204 No Content

Single Shipment, Multi-Product

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": "FooBar",
    "DistributionCenterID": 0,
    "DeliveryStatus": "Complete",
    "ShippingCarrier": "UPS",
    "ShippingClass": "Ground",
    "Items":[
    {
      "Sku":"ABC",
      "Quantity":1,
	  "SellerFulfillmentItemID": "M2_B8_20140704"
    },
	{
      "Sku":"DEF",
      "Quantity":1,
	  "SellerFulfillmentItemID": "M2_B1_20140705"
    }]
  }
}
Example Response (Success)
204 No Content

Two Shipment, Single Product Each Shipment

Example Request
First 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": "First Shipment",
    "DistributionCenterID": 0,
    "DeliveryStatus": "Complete",
    "ShippingCarrier": "UPS",
    "ShippingClass": "Ground",
    "Items":[
    {
      "Sku":"ABC",
      "Quantity":2,
	  "SellerFulfillmentItemID": "A7"
    }]
  }
}

Second Request: 
POST https://api.channeladvisor.com/v1/Orders(123456)/Ship?access_token=xxxxxxxxxx
{
  "Value":{
    "ShippedDateUtc": "2014-07-05T05:22:07.1Z",
    "TrackingNumber": "1Z 999 AA1 01 2345 5555",
    "SellerFulfillmentID": "Second Shipment",
    "DistributionCenterID": 0,
    "DeliveryStatus": "Complete",
    "ShippingCarrier": "UPS",
    "ShippingClass": "Ground",
    "Items":[
    {
      "Sku":"DEF",
      "Quantity":1,
	  "SellerFulfillmentItemID": "M50"
    }]
  }
}
Example Response (Success)
For Both Requests:
204 No Content