GetOrderShipmentHistoryList

Overview

Retrieve the shipment history of an order

Request

Field Name

Data Type

Description

accountID

string

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

orderIDList

int[]

List of Order IDs specifying the orders to retrieve

clientOrderIdentifierList

string[]

List of client order identifiers specifying the orders to retrieve. If both lists are submitted, the response will contain the union of the two lists

Response

Field Name

Data Type

Description

GetOrderShipmentHistoryListResult

APIResult<OrderShipmentHistoryResponse>

This method returns a type named APIResultOfOrderShipmentHistoryResponse. See more information on APIResult.

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:GetOrderShipmentHistoryList>
         <web:accountID>...</web:accountID>
         <web:orderIDList>
            <web:int>8972602</web:int>
         </web:orderIDList>
         <web:clientOrderIdentifierList>
            <web:string>897-ABCDE-2552</web:string>
         </web:clientOrderIdentifierList>
      </web:GetOrderShipmentHistoryList>
   </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>
      <GetOrderShipmentHistoryListResponse xmlns="http://api.channeladvisor.com/webservices/">
         <GetOrderShipmentHistoryListResult>
            <Status>Success</Status>
            <MessageCode>0</MessageCode>
            <ResultData>
               <OrderShipmentHistoryResponse>
                  <OrderID xmlns="http://api.channeladvisor.com/datacontracts/ShippingService">8972602</OrderID>
                  <ClientOrderIdentifier xmlns="http://api.channeladvisor.com/datacontracts/ShippingService">8972602</ClientOrderIdentifier>
                  <ShippingStatus xmlns="http://api.channeladvisor.com/datacontracts/ShippingService">Shipped</ShippingStatus>
                  <ShippingStatusUpdateDateGMT xmlns="http://api.channeladvisor.com/datacontracts/ShippingService">2012-01-31T16:02:47</ShippingStatusUpdateDateGMT>
                  <OrderShipments xmlns="http://api.channeladvisor.com/datacontracts/ShippingService">
                     <OrderShipmentResponse>
                        <ShipmentDateGMT>2012-01-30T16:30:00</ShipmentDateGMT>
                        <CarrierCode>UPS</CarrierCode>
                        <ClassCode>GROUND</ClassCode>
                        <TrackingNumber>B</TrackingNumber>
                        <DistributionCenterCode>Morrisville</DistributionCenterCode>
                        <ShipmentCost>2.0000</ShipmentCost>
                        <ShipmentTaxCost>0.0700</ShipmentTaxCost>
                        <ShipmentInsuranceCost>0.0000</ShipmentInsuranceCost>
                        <SellerFulfillmentID/>
                        <ShipmentLineItems>
                           <ShipmentLineItemResponse>
                              <LineItemID>17267757</LineItemID>
                              <SKU>Sku1</SKU>
                              <Quantity>1</Quantity>
                           </ShipmentLineItemResponse>
                        </ShipmentLineItems>
                     </OrderShipmentResponse>
                  </OrderShipments>
               </OrderShipmentHistoryResponse>
               <OrderShipmentHistoryResponse>
                  <OrderID xmlns="http://api.channeladvisor.com/datacontracts/ShippingService">8972552</OrderID>
                  <ClientOrderIdentifier xmlns="http://api.channeladvisor.com/datacontracts/ShippingService">897-ABCDE-2552</ClientOrderIdentifier>
                  <ShippingStatus xmlns="http://api.channeladvisor.com/datacontracts/ShippingService">Shipped</ShippingStatus>
                  <ShippingStatusUpdateDateGMT xmlns="http://api.channeladvisor.com/datacontracts/ShippingService">2012-01-30T16:30:00</ShippingStatusUpdateDateGMT>
                  <OrderShipments xmlns="http://api.channeladvisor.com/datacontracts/ShippingService">
                     <OrderShipmentResponse>
                        <ShipmentDateGMT>2012-01-30T16:30:00</ShipmentDateGMT>
                        <CarrierCode>UPS</CarrierCode>
                        <ClassCode>GROUND</ClassCode>
                        <TrackingNumber>2</TrackingNumber>
                        <DistributionCenterCode>Morrisville</DistributionCenterCode>
                        <ShipmentCost>2.0000</ShipmentCost>
                        <ShipmentTaxCost>0.6800</ShipmentTaxCost>
                        <ShipmentInsuranceCost>0.0000</ShipmentInsuranceCost>
                        <SellerFulfillmentID/>
                        <ShipmentLineItems>
                           <ShipmentLineItemResponse>
                              <LineItemID>17267699</LineItemID>
                              <SKU>Sku10</SKU>
                              <Quantity>1</Quantity>
                           </ShipmentLineItemResponse>
                        </ShipmentLineItems>
                     </OrderShipmentResponse>
                  </OrderShipments>
               </OrderShipmentHistoryResponse>
            </ResultData>
         </GetOrderShipmentHistoryListResult>
      </GetOrderShipmentHistoryListResponse>
   </soap:Body>
</soap:Envelope>

References