SubmitOrderShipmentList

Overview

Create partial or full shipments for multiple orders, where a partial shipment can contain a subset of previously unshipped quantity for the items on an existing order. If a partial shipment completes an order, then the Shipping Status will be changed accordingly.

Note: This method also supports updates to existing shipments.  An order must be fully shipped before updates may be issued, and the items listed in the update must match the original shipment.  If an update is submitted as a full shipment, then the least-recently updated shipment will be updated.

Request

Field Name

Data Type

Description

accountID

string

A unique identifier representing the ChannelAdvisor account you wish to access.

shipmentList

OrderShipment[]

Array of one or more partial and/or full order shipment details.  Max 50

Response

Field Name

Data Type

Description

SubmitOrderShipmentListResult

APIResult<ShipmentResponse[]>

This method returns a type named APIResultOfArrayOfShipmentResponse. See more information on APIResult. Each element in ResultData indicates the success or failure of a shipment notification from the request.

Sample XML Request/Response

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://api.channeladvisor.com/webservices/">
   <soapenv:Header>
      <web:APICredentials>
         <web:DeveloperKey>...</web:DeveloperKey>
         <web:Password>...</web:Password>
      </web:APICredentials>
   </soapenv:Header>
   <soapenv:Body>
      <web:SubmitOrderShipmentList>
         <web:accountID>...</web:accountID>
         <web:shipmentList>
            <web:OrderID>8799545</web:OrderID>
            <web:ShipmentType>Full</web:ShipmentType>
            <web:FullShipment>
               <web:DateShippedGMT>2010-04-20T09:00:42</web:DateShippedGMT>
               <web:CarrierCode>UPS</web:CarrierCode>
               <web:ClassCode>STD</web:ClassCode>
               <web:TrackingNumber>314159265358979323</web:TrackingNumber>
               <web:ShipmentCost>2.50</web:ShipmentCost>
               <web:ShipmentTaxCost>0</web:ShipmentTaxCost>
               <web:InsuranceCost>0</web:InsuranceCost>
            </web:FullShipment>
         </web:shipmentList>
      </web:SubmitOrderShipmentList>
   </soapenv:Body>
</soapenv:Envelope>


<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <soap:Body>
      <SubmitOrderShipmentListResponse xmlns="http://api.channeladvisor.com/webservices/">
         <SubmitOrderShipmentListResult>
            <Status>Success</Status>
            <MessageCode>0</MessageCode>
            <ResultData>
               <ShipmentResponse>
                  <Success xmlns="http://api.channeladvisor.com/datacontracts/ShippingService">true</Success>
               </ShipmentResponse>
            </ResultData>
         </SubmitOrderShipmentListResult>
      </SubmitOrderShipmentListResponse>
   </soap:Body>
</soap:Envelope>