SetSellerOrderID

Overview

This function is used to set the SellerOrderID value for an Order.  An Order has 3 possible identifiers.  The OrderID is a unique number assigned by ChannelAdvisor.  The ClientOrderIdentifier is the identifier that is displayed in the All Sales View.  The SellerOrderID is a private identifier that a seller can specify to indicate a value that they use to identify an Order.  This number is a search-enabled field on the All Sales View.
This function takes two arrays as parameters.  These arrays should have the same number of elements.  The elements in both arrays are related by position.  Thus, the first element in the sellerOrderIDList array corresponds to the first element in the orderIDList array and so on.

Request

Field Name

Data Type

Description

accountID

string

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

orderIDList

int[]

An array of OrderID values that should be updated

sellerOrderIDList

string[]

An array of SellerOrderID values.  The number of elements in this array should match the number of elements in the orderIDList array.

Response

Field Name

Data Type

Description

SetSellerOrderIDResult

APIResult<int[]>

This method returns a type named APIResultOfArrayOfInt32. See more information on APIResult. The ResultData field.will contain an array of integer OrderID values.  This array identifies the orders that were successfully updated by this method.  If all orders were updated, then the number of element in the orderIDList input array will be the same as the number of elements in the ResultData array field.

XML Samples


<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:SetSellerOrderID>
         <web:accountID></web:accountID>
         <web:orderIDList>
            <web:int>9010244</web:int>
            <web:int>9002303</web:int>
            <web:int>9002304</web:int>
         </web:orderIDList>
         <web:sellerOrderIDList>
            <web:string>abc123456</web:string>
            <web:string>abc123457</web:string>
            <web:string>abc123458</web:string>
         </web:sellerOrderIDList>
      </web:SetSellerOrderID>
   </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>
      <SetSellerOrderIDResponse xmlns="http://api.channeladvisor.com/
webservices/">
         <SetSellerOrderIDResult>
            <Status>Success</Status>
            <MessageCode>0</MessageCode>
            <ResultData>
               <int>9010244</int>
               <int>9002303</int>
               <int>9002304</int>
            </ResultData>
         </SetSellerOrderIDResult>
      </SetSellerOrderIDResponse>
   </soap:Body>
</soap:Envelope> 

References