OrderShipment

Overview

Details for one partial or full shipment.

Fields

Field Name

Data Type

Description

Notes / Constraints

OrderID

int

The ChannelAdvisor order identifier.

Takes precedence over ClientOrderIdentifier but is not required if ClientOrderIdentifier is provided.

ClientOrderIdentifier

string

The order number as seen in the ChannelAdvisor user interface; provided by the marketplace or seller.

Ignored if OrderID is provided but required if OrderID is not provided.

ShipmentType

string

Specifies whether this is a full or partial shipment. Must be set to one of the following values:

  • Partial
  • Full


PartialShipment

PartialShipmentContents

Shipment details and line item contents for the partial shipment within this order.

Must be specified if ShipmentType is Partial, otherwise ignored.

FullShipment

FullShipmentContents

Shipment details for all previously unshipped items in the order. (Completes the order).

Must be specified if ShipmentType is Full, otherwise ignored.

References