GetOrderFulfillmentDetailList

Overview

Retrieve all fulfillment details of one or more orders.

Request

Field Name

Data Type

Description

accountID

string

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

orderIDList

int[]

List of OrderID values specifying the orders for which fulfillments should be retrieved.  If both identifier lists are submitted, the response will contain the union of the two lists.

clientOrderIdentifierList

string[]

List of ClientOrderIdentifier values specifying the orders for which fulfillments should be retrieved.

Response

Field Name

Data Type

Description

GetOrderFulfillmentDetailListResult

APIResult<OrderFulfillmentResponse[]>

This method returns a type named APIResultOfArrayOfOrderFulfillmentResponse. See more information on APIResult. The fulfillment data returned by this method will be contained in the ResultData field.

References

Sample XML Request and Response

Unfulfilled Order Example


<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://api.channeladvisor.com/webservices/">
   <soapenv:Header>
      <web:APICredentials>
         <!--Optional:-->
         <web:DeveloperKey>...web:DeveloperKey>
         <!--Optional:-->
         <web:Password>...</web:Password>
      </web:APICredentials>
   </soapenv:Header>
   <soapenv:Body>
      <web:GetOrderFulfillmentDetailList>
         <web:accountID>...</web:accountID>
         <!--Optional:-->
         <web:orderIDList>
            <!--Zero or more repetitions:-->
            <web:int>19569130</web:int>
         </web:orderIDList>
         <!--Optional:-->
         <web:clientOrderIdentifierList>
            <!--Zero or more repetitions:-->
            <web:string></web:string>
         </web:clientOrderIdentifierList>
      </web:GetOrderFulfillmentDetailList>
   </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>
      <GetOrderFulfillmentDetailListResponse xmlns="http://api.channeladvisor.com/webservices/">
         <GetOrderFulfillmentDetailListResult>
            <Status>Success</Status>
            <MessageCode>0</MessageCode>
            <ResultData>
               <OrderFulfillmentResponse>
                  <OrderID>19569130</OrderID>
                  <FulfillmentList>
                     <FulfillmentDetailResponse>
                        <FulfillmentID>10926239</FulfillmentID>
                        <CreatedDateGMT>2014-02-26T15:40:30</CreatedDateGMT>
                        <UpdatedDateGMT>2014-02-26T15:43:16.62</UpdatedDateGMT>
                        <FulfillmentType>Ship</FulfillmentType>
                        <FulfillmentStatus>NoChange</FulfillmentStatus>
                        <CarrierCode>Amazon Merchants@</CarrierCode>
                        <ClassCode>Standard</ClassCode>
                        <DistributionCenterCode>Morrisville</DistributionCenterCode>
                        <Cost>0.0000</Cost>
                        <TaxCost>0.0000</TaxCost>
                        <InsuranceCost>0.0000</InsuranceCost>
                        <ShippedDateGMT xsi:nil="true"/>
                        <ItemList>
                           <FulfillmentItemDetailResponse>
                              <FulfillmentItemID>6925226</FulfillmentItemID>
                              <SKU>AS546sumtest</SKU>
                              <Quantity>1</Quantity>
                              <LineItemID>21877977</LineItemID>
                              <SiteAuctionID>42784407</SiteAuctionID>
                              <SaleSourceID>42784407</SaleSourceID>
                           </FulfillmentItemDetailResponse>
                           <FulfillmentItemDetailResponse>
                              <FulfillmentItemID>6925227</FulfillmentItemID>
                              <SKU>spidi7445sum-test</SKU>
                              <Quantity>1</Quantity>
                              <LineItemID>21877978</LineItemID>
                              <SiteAuctionID>42784408</SiteAuctionID>
                              <SaleSourceID>42784408</SaleSourceID>
                           </FulfillmentItemDetailResponse>
                        </ItemList>
                     </FulfillmentDetailResponse>
                  </FulfillmentList>
               </OrderFulfillmentResponse>
            </ResultData>
         </GetOrderFulfillmentDetailListResult>
      </GetOrderFulfillmentDetailListResponse>
   </soap:Body>
</soap:Envelope>

Fulfilled Order Example


<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://api.channeladvisor.com/webservices/">
   <soapenv:Header>
      <web:APICredentials>
         <!--Optional:-->
         <web:DeveloperKey>...</web:DeveloperKey>
         <!--Optional:-->
         <web:Password>...</web:Password>
      </web:APICredentials>
   </soapenv:Header>
   <soapenv:Body>
      <web:GetOrderFulfillmentDetailList>
         <web:accountID>...</web:accountID>
         <web:orderIDList>
         <web:int>19555327</web:int>
         </web:orderIDList>
         <web:clientOrderIdentifierList>
         <web:string></web:string>
         </web:clientOrderIdentifierList>
      </web:GetOrderFulfillmentDetailList>
   </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>
      <GetOrderFulfillmentDetailListResponse xmlns="http://api.channeladvisor.com/webservices/">
         <GetOrderFulfillmentDetailListResult>
            <Status>Success</Status>
            <MessageCode>0</MessageCode>
            <ResultData>
               <OrderFulfillmentResponse>
                  <OrderID>19555327</OrderID>
                  <FulfillmentList>
                     <FulfillmentDetailResponse>
                        <FulfillmentID>10912195</FulfillmentID>
                        <CreatedDateGMT>2014-01-30T20:30:24.547</CreatedDateGMT>
                        <UpdatedDateGMT>2014-01-30T20:30:24.547</UpdatedDateGMT>
                        <FulfillmentType>Ship</FulfillmentType>
                        <FulfillmentStatus>NoChange</FulfillmentStatus>
                        <CarrierCode>eBay</CarrierCode>
                        <ClassCode>Standard</ClassCode>
                        <DistributionCenterCode>Morrisville</DistributionCenterCode>
                        <Cost>0.0000</Cost>
                        <TaxCost>0.0000</TaxCost>
                        <InsuranceCost>0.0000</InsuranceCost>
                        <ShippedDateGMT xsi:nil="true"/>
                        <ItemList>
                           <FulfillmentItemDetailResponse>
                              <FulfillmentItemID>6910734</FulfillmentItemID>
                              <SKU>dainese7898</SKU>
                              <Quantity>1</Quantity>
                              <LineItemID>21863890</LineItemID>
                              <SiteAuctionID>AuctionId_3de2a94a-5a55-4bf5-acb6-36d95e2907b8</SiteAuctionID>
                              <SaleSourceID/>
                           </FulfillmentItemDetailResponse>
                        </ItemList>
                     </FulfillmentDetailResponse>
                     <FulfillmentDetailResponse>
                        <FulfillmentID>10912196</FulfillmentID>
                        <CreatedDateGMT>2014-01-30T20:31:16.743</CreatedDateGMT>
                        <UpdatedDateGMT>2014-01-30T20:31:16.743</UpdatedDateGMT>
                        <FulfillmentType>Ship</FulfillmentType>
                        <FulfillmentStatus>Complete</FulfillmentStatus>
                        <CarrierCode>UPS</CarrierCode>
                        <ClassCode>Standard</ClassCode>
                        <TrackingNumber>1231231231231zsd12</TrackingNumber>
                        <DistributionCenterCode>Morrisville</DistributionCenterCode>
                        <Cost>0.0000</Cost>
                        <TaxCost>0.0000</TaxCost>
                        <InsuranceCost>0.0000</InsuranceCost>
                        <ShippedDateGMT>2014-01-30T05:00:00</ShippedDateGMT>
                        <ItemList>
                           <FulfillmentItemDetailResponse>
                              <FulfillmentItemID>6910735</FulfillmentItemID>
                              <SKU>dainese7898sum</SKU>
                              <Quantity>1</Quantity>
                              <LineItemID>21863889</LineItemID>
                              <SiteAuctionID>AuctionId_8317a023-b03e-4167-93f5-a0ff0d150661</SiteAuctionID>
                              <SaleSourceID/>
                           </FulfillmentItemDetailResponse>
                        </ItemList>
                     </FulfillmentDetailResponse>
                  </FulfillmentList>
               </OrderFulfillmentResponse>
            </ResultData>
         </GetOrderFulfillmentDetailListResult>
      </GetOrderFulfillmentDetailListResponse>