RemoveFromWatchList

Use this call to remove one or more items from the authenticated user's My eBay watch list.

Usage Details

You can use RemoveFromWatchList to remove either specific items, or to remove all items from the user's My eBay watch list. Specify multiple ItemID input arguments to remove any number of items from the watch list in one call. Alternatively, use the RemoveAllItems input argument to remove all the items from the user's watch list.

The call response contains two integers, WatchListCount and WatchListMaximum, which you can use to determine how many items are currently being tracked, and how many available spaces there are in the user's watch list.

Testing RemoveFromWatchList

You can test this call in the Sandbox, as follows:

1. Find an item in the My eBay Sandbox page: http://sandbox.ebay.com and save the item ID.
2. Call to AddToWatchList on behalf of a test user, and add the item from the previous step to the user's My eBay watch list. (Alternately, you can add the item to the user's watch list through the Sandbox web site.)
3. Verify that the item is on the user's watch list in one of two ways:
   • Sign-in to the Sandbox as the test user and look for the item in the watch list on their My eBay page.
   • Call GetMyeBayBuying to retrieve the user's watch list, and verify that the item is included in the list.
4. Use RemoveFromWatchList to remove the item from the user's watch list.
5. Verify that the item is no longer on the user's the watch list:
   • Sign-in to the Sandbox as the test user and verify that it has been removed from the watch list on their My eBay page.
   • Call GetMyeBayBuying to retrieve the user's watch list, and verify that the item is not included in the list.

Related Information

See also the reference documentation for this call:

• GetMyeBayBuying - Retrieves information regarding a user's buying activity, such as items they are watching, bidding on, have won, did not win, and have made Best Offers on.

Input

See also Samples.

The box below lists all fields that could be included in the call request. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).

See also the Deprecated Objects link above. Fields presented in this color are deprecated, and fields presented in this color are (or soon will be) non-operational.

The XML prototype does not include requester credentials. This is a documentation limitation only (see Standard Requester Credentials for Making Calls).

<?xml version="1.0" encoding="utf-8"?>
<RemoveFromWatchListRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Call-specific Input Fields -->
  <ItemID> ItemIDType (string) </ItemID>
  <!-- ... more ItemID values allowed here ... -->
  <RemoveAllItems> boolean </RemoveAllItems>
  <VariationKey> VariationKeyType
    <ItemID> ItemIDType (string) </ItemID>
    <VariationSpecifics> NameValueListArrayType
      <NameValueList> NameValueListType
        <Name> string </Name>
        <Value> string </Value>
        <!-- ... more Value values allowed here ... -->
      </NameValueList>
      <!-- ... more NameValueList nodes allowed here ... -->
    </VariationSpecifics>
  </VariationKey>
  <!-- ... more VariationKey nodes allowed here ... -->
  <!-- Standard Input Fields -->
  <ErrorLanguage> string </ErrorLanguage>
  <MessageID> string </MessageID>
  <Version> string </Version>
  <WarningLevel> WarningLevelCodeType </WarningLevel>
</RemoveFromWatchListRequest>

Output

See also Samples.

The box below lists all fields that might be returned in the response. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).

See also the Deprecated Objects link above. Fields presented in this color are deprecated, and fields presented in this color are not returned (or soon will not be returned) or are not operational (or soon will be non-operational).

<?xml version="1.0" encoding="utf-8"?>
<RemoveFromWatchListResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Call-specific Output Fields -->
  <WatchListCount> int </WatchListCount>
  <WatchListMaximum> int </WatchListMaximum>
  <!-- Standard Output Fields -->
  <Ack> AckCodeType </Ack>
  <Build> string </Build>
  <CorrelationID> string </CorrelationID>
  <Errors> ErrorType
    <ErrorClassification> ErrorClassificationCodeType </ErrorClassification>
    <ErrorCode> token </ErrorCode>
    <ErrorParameters ParamID="string"> ErrorParameterType
      <Value> string </Value>
    </ErrorParameters>
    <!-- ... more ErrorParameters nodes allowed here ... -->
    <LongMessage> string </LongMessage>
    <SeverityCode> SeverityCodeType </SeverityCode>
    <ShortMessage> string </ShortMessage>
  </Errors>
  <!-- ... more Errors nodes allowed here ... -->
  <HardExpirationWarning> string </HardExpirationWarning>
  <Timestamp> dateTime </Timestamp>
  <Version> string </Version>
</RemoveFromWatchListResponse>

Detail Controls

DetailLevel

This call does not support varying Detail Levels. You do not need to pass DetailLevel in the request.

Samples

New to making API calls? Please see Making a Call.

Note: Some item IDs, user IDs, or other data in these samples might no longer be active on eBay. If necessary, you can substitute current eBay data in your requests.

Removes an item from a user's My eBay Watch List.

Description

A buyer removes a listing (or variation within a listing) from their My eBay Watch List.

Input

To remove a single listing from a user's Watch List, the unique identifier is passed in through the ItemID field.

XML format.

<?xml version="1.0" encoding="utf-8"?>
<RemoveFromWatchListRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <RequesterCredentials>
    <eBayAuthToken>A*******3</eBayAuthToken>
  </RequesterCredentials>
  <ItemID>1**********7</ItemID>
</RemoveFromWatchListRequest>

Output

If the listing was successfully removed from the user's Watch List, an Ack value of 'Success' is returned. The user's current Watch List count (and the maximum amount of items/variations that can be added to the Watch List) is also returned.

XML format.
<?xml version="1.0" encoding="UTF-8"?>
<RemoveFromWatchListResponse 
  xmlns="urn:ebay:apis:eBLBaseComponents">
  <Timestamp>2019-11-06T18:22:41.688Z</Timestamp>
  <Ack>Success</Ack>
  <Version>1125</Version>
  <Build>E1125_CORE_API_19070409_R1</Build>
  <WatchListCount>5</WatchListCount>
  <WatchListMaximum>300</WatchListMaximum>
</RemoveFromWatchListResponse>

Change History