PartialShipmentContents

Overview

Details for one partial shipment.

Fields

Field Name

Data Type

Description

Example

Notes / Constraints

LineItemList

LineItem[]

The line item details of this partial shipment (SKU and Qty)



DateShippedGMT

DateTime

The date and time the order was shipped, in Universal Coordinated Time (UTC).

2009-09-22T19:24:30Z

Optional, defaults to current time if not provided.

CarrierCode

string

The shipping carrier code value used to ship the item.

USPS

Must be registered in the seller's ChannelAdvisor account. Not to be confused with carrier name, e.g. "US Postal Service"

ClassCode

string

The shipping carrier class code value used to ship the item.

FIRSTCLASS

Must be registered in the seller's ChannelAdvisor account. Not to be confused with class name, e.g. "First-Class Mail".

TrackingNumber

string

The tracking number provided by a shipping carrier

TTZZ111222333444

The raw tracking string, do not supply HTML. Required, but blank may be supplied if not known.

SellerFulfillmentID

string

An optional identifier provided by the seller

123456789


ShipmentCost

decimal

The amount charged for shipment alone to the buyer

12.99

Optional only for limited scenario where an order requires shipment before payment.
Exclude in all other scenarios.
Does not include tax or insurance.

This is NOT the actual fulfillment cost paid by the seller.
Use FulfillmentUpdateSubmit to update fulfillment cost.

ShipmentTaxCost

decimal

The amount charged for the tax on the shipment to the buyer

1.75

Optional only for limited scenario where an order requires shipment before payment.
Exclude in all other scenarios.

This is NOT the actual fulfillment cost paid by the seller.
Use FulfillmentUpdateSubmit to update fulfillment cost.

InsuranceCost

decimal

The amount charged for the insurance on the shipment to the buyer

2.50

Optional only for limited scenario where an order requires shipment before payment.
Exclude in all other scenarios.

This is NOT the actual fulfillment insurance cost paid by the seller.
Use FulfillmentUpdateSubmit to update fulfillment cost.

FulfillmentType

string

Indicates the fulfillment type using values from FulfillmentTypeCode

Ship

Optional, defaults to Ship.

FulfillmentStatus

string

Indicates the fulfillment status using values from FulfillmentStatus

Complete

Optional, defaults to Complete.

Notes

  • A list of valid carrier and class codes for the account can be retrieved with GetShippingCarrierList.  The Knowledge Center contains some examples.
  • The cost fields must be omitted if payment has already cleared for the order.  In lieu of omitting the fields, the value -9999 may be submitted instead.
  • More Complicated Examples:
    1. Scenario 1: If an order is shipped in two batches, you can either send two "Partial" commands, or 1 "Partial" (for the first batch) and 1 "Full" (for everything left).
    2. Scenario 2: If an order has one out of a total of three items cancelled prior to shipment, you can ship Item 1, cancel Item 2, and ship Item 3. Our system will detect this as a fully shipped order.

References