AddToWatchList

This call is used to add one or more items to a user's My eBay Watch list. The My eBay Watch list can be viewed on the user's My eBay page, or the list can be retrieved using GetMyeBayBuying.

Note: Only active listings can be added to a Watch list. If a user was watching an item when the listing ended, that item will be added back to the user's Watch list if the item is relisted.

Usage Details

Call AddToWatchList with one or more ItemID fields. Each active item is added to the user's Watch list.

The call response contains two fields, WatchListCount and WatchListMaximum. You can use these values to determine how many items are currently being watched, and how many available spaces are left in the user's Watch list.

Testing AddToWatchList

Test AddToWatchList in the Sandbox:

1. Find an item on the My eBay Sandbox page (http://sandbox.ebay.com) and get the ItemID value.
2. Make a call to AddToWatchList on behalf of a test user, adding the Sandbox item to the user's My eBay Watch list.
3. Verify that the item is in the 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 the My eBay page.
   • Use GetMyeBayBuying to retrieve the user's Watch list, and verify that the item is included in the list.

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"?>
<AddToWatchListRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Call-specific Input Fields -->
  <ItemID> ItemIDType (string) </ItemID>
  <!-- ... more ItemID values allowed here ... -->
  <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>
</AddToWatchListRequest>

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"?>
<AddToWatchListResponse 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>
</AddToWatchListResponse>

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.

Adds an item (or items) to a buyers Watch List.

Description

Using the Finding API, a potential buyer has found several Harry Potter books that she is interested in buying. The seller's book (M*****l B********r) is of particular interest and the potential buyer wants to keep an eye on the auction's progress.

Using AddToWatchList, the potential buyer adds the Harry Potter book to her Watch List. The call returns the current number of items on her Watch List, along with the maximum number of items that she can watch at a time. Subtract the WatchListCount value from WatchListMaximum to calculate how many additional watches potential buyer can add to her watch list.

Input

XML format.

<?xml version="1.0" encoding="utf-8"?>
<AddToWatchListRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <RequesterCredentials>
    <eBayAuthToken>A*******3</eBayAuthToken>
  </RequesterCredentials>
  <WarningLevel>High</WarningLevel>
  <!-- Must be the Item ID of an active listing -->
  <ItemID>1**********7</ItemID>
</AddToWatchListRequest>

Output

XML format.
<?xml version="1.0" encoding="UTF-8"?>
<AddToWatchListResponse 
  xmlns="urn:ebay:apis:eBLBaseComponents">
  <Timestamp>2018-10-29T20:09:48.639Z</Timestamp>
  <Ack>Success</Ack>
  <Version>1081</Version>
  <Build>E1081_CORE_API_18809323_R1</Build>
  <WatchListCount>6</WatchListCount>
  <WatchListMaximum>300</WatchListMaximum>
</AddToWatchListResponse>

Change History