SetOrdersExportStatus

Overview

This synchronous function is used to indicate the caller has successfully received the orders listed in orderIDList and/or clientOrderIdentifierList.

  • The orders are marked as exported specifically by the DeveloperKey making the request. This allows for various client applications to poll for unexported orders without causing collisions between the two applications.
  • Marking an order as exported/not-exported will not update the LastUpdateDate in the OrderResponseItem.
  • The list of orders being marked exported is the union of the OrderID and ClientOrderIdentifier arrays.

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 specifying which orders should be marked as exported.  OrderID is the order identifier generated by ChannelAdvisor.

clientOrderIdentifierList

string[]

An array of ClientOrderIdentifier values specifying which orders should be marked as exported.  ClientOrderIdentifier is the order identifier displayed in the ChannelAdvisor user interface; it is provided by the marketplace.

markAsExported

boolean

True will mark the orders as exported. False will mark the orders as not exported.

Response

Field Name

Data Type

Description

SetOrdersExportStatusResult

APIResult<SetExportStatusResponse[]>

This method returns an object of type APIResultOfArrayOfSetExportStatusResponse. ResultData will contain an array of SetExportStatusResponse matching the union of the arrays of orderIDs and clientOrderIdentifiers from the request.

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>
         <web:DeveloperKey>...</web:DeveloperKey>
         <web:Password>...</web:Password>
      </web:APICredentials>
   </soapenv:Header>
   <soapenv:Body>
      <web:SetOrdersExportStatus>
         <web:accountID>...</web:accountID>
        <web:orderIDList>
            <web:int>12345678</web:int>
            <web:int>12345679</web:int>
        </web:orderIDList>
         <web:clientOrderIdentifierList>
            <web:string>S-439780</web:string>
            <web:string>S-439354</web:string>
         </web:clientOrderIdentifierList>
         <web:markAsExported>true</web:markAsExported>
      </web:SetOrdersExportStatus>
   </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>
      <SetOrdersExportStatusResponse xmlns="http://api.channeladvisor.com/webservices/">
         <SetOrdersExportStatusResult>
            <Status>Success</Status>
            <MessageCode>0</MessageCode>
            <ResultData>
                <SetExportStatusResponse>
                    <OrderID>12345678</OrderID>
                    <Success>true</Success>
                </SetExportStatusResponse>
                <SetExportStatusResponse>
                    <OrderID>12345679</OrderID>
                    <Success>true</Success>
                </SetExportStatusResponse>
                <SetExportStatusResponse>
                    <OrderID>12345680</OrderID>
                    <ClientOrderIdentifier>S-439780</ClientOrderIdentifier>
                    <Success>true</Success>
                </SetExportStatusResponse>
                <SetExportStatusResponse>
                    <OrderID>1234568011</OrderID>
                    <ClientOrderIdentifier>S-439354</ClientOrderIdentifier>
                    <Success>true</Success>
                </SetExportStatusResponse>
            </ResultData>
         </SetOrdersExportStatusResult>
      </SetOrdersExportStatusResponse>
   </soap:Body>
</soap:Envelope>

References