WithdrawListings

Overview

Withdraw open listings from the marketplace to prevent any further sales. Currently this only supports eBay listings. Other marketplaces will not be withdrawn. Requests can be submitted using SKU, listing ID, or both. When both are used the union of applicable items will be withdrawn. At least one of SKU or listing ID is required.

When a SKU is submitted, all listings for that SKU are withdrawn. If the SKU is a parent SKU, all of the child SKUs will be withdrawn as if each child SKU had been sent individually. For performance reasons, a combined maximum of 500 SKUs and ListingIDs is recommended. Larger requests take longer to process and could exceed maximum execution time limits.

Withdraw requests are not synchronous. The requests submitted are successfully queued and the number of withdraw requests is included in the response. While those requests have been submitted to the marketplace, there is a possibility that they will not complete successfully.

Request

Field Name

Data Type

Description

accountID

string

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

skuList

string[]

Optional list of SKUs to be withdrawn.

listingIDList

string[]

Optional list of listing IDs to be withdrawn.

withdrawReason

WithdrawReason

One of:

  • ItemWasLostOrBroken
  • ItemNoLongerAvailableForSale
  • ErrorInMinimumBidOrReserve
  • ErrorInTheListing

Response

Field Name

Data Type

Description

ResultData

APIResult<int>

Number of open listings found that were successfully submitted for a withdraw. While most requests are successful, the marketplace may not allow a withdraw on certain listings and retain the item as open.

Sample XML Request


<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:web="http://api.channeladvisor.com/webservices/">
<soapenv:Header>
   <web:APICredentials>
   <web:DeveloperKey>11111111-1111-1111-1111-999999999999</web:DeveloperKey>
   <web:Password>mypassword</web:Password>
   </web:APICredentials>
</soapenv:Header>
<soapenv:Body>
   <web:WithdrawListings>
      <web:accountID>22222222-2222-2222-2222-999999999999</web:accountID>
      <web:skuList>
         <web:string><![CDATA[ SKU1 ]]></web:string>
         <web:string><![CDATA[ SKU2 ]]></web:string>
      </web:skuList>
      <web:listingIDList>
         <web:string>12345</web:string>
         <web:string>67890</web:string>
      </web:listingIDList>
      <web:withdrawReason>ErrorInMinimumBidOrReserve</web:withdrawReason>
   </web:WithdrawListings>
</soapenv:Body>
</soapenv:Envelope>