CreateOrderFulfillments

Overview

Create a new fulfillment, setting fulfillment type and status, carrier, class, tracking, DC, cost (for unpaid orders), shipped date, seller fulfillment ID, and items.  If possible, the existing fulfillments on the order will be rearranged to accommodate the request.

Request

Field Name

Data Type

Description

accountID

string

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

orderID

int

The internal ChannelAdvisor order identifier. Required if ClientOrderIdentifier is not supplied.

clientOrderIdentifier

string

The order number as seen in the ChannelAdvisor user interface. Required if OrderID is not supplied.

fulfillmentList

FulfillmentCreateSubmit[]

The list of fulfillments to be created.

Response

Field Name

Data Type

Description

CreateOrderFulfillmentsResponse

APIResult<FulfillmentOperationResponse[]>

This method returns a type named APIResultOfArrayOfFulfillmentOperationResponse. See more information on APIResult. The results of the operations performed by the method will be contained in the ResultData field.

References

Sample XML Request and Response


<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:CreateOrderFulfillments>
         <web:accountID>...</web:accountID>
         <web:orderID>19555321</web:orderID>
         
         <web:fulfillmentList>
            <!--Zero or more repetitions:-->
            <web:FulfillmentCreateSubmit>
               <!--Optional:-->
               <web:FulfillmentType>Ship</web:FulfillmentType>
               <!--Optional:-->
               <web:FulfillmentStatus>Complete</web:FulfillmentStatus>
               <!--Optional:-->
               <web:CarrierCode>UPS</web:CarrierCode>
               <!--Optional:-->
               <web:ClassCode>GROUND</web:ClassCode>
               <!--Optional:-->
               <web:TrackingNumber>1zwzxy12321232121211</web:TrackingNumber>
               <!--Optional:-->
               <web:DistributionCenterCode>Morrisville</web:DistributionCenterCode>
               <web:ShippedDateGMT>2014-02-25T20:39:24</web:ShippedDateGMT>
               <web:ItemList>
                  <!--Zero or more repetitions:-->
                  <web:FulfillmentItemSubmit>
                     <web:FulfillmentItemID>6910727</web:FulfillmentItemID>
                     <web:Quantity>1</web:Quantity>
                  </web:FulfillmentItemSubmit>
               </web:ItemList>
            </web:FulfillmentCreateSubmit>
         </web:fulfillmentList>
      </web:CreateOrderFulfillments>
   </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>
      <CreateOrderFulfillmentsResponse xmlns="http://api.channeladvisor.com/webservices/">
         <CreateOrderFulfillmentsResult>
            <Status>Success</Status>
            <MessageCode>0</MessageCode>
            <ResultData>
               <FulfillmentOperationResponse>
                  <FulfillmentID>10925934</FulfillmentID>
                  <Success>true</Success>
               </FulfillmentOperationResponse>
            </ResultData>
         </CreateOrderFulfillmentsResult>
      </CreateOrderFulfillmentsResponse>
   </soap:Body>
</soap:Envelope>