RemoveFromWatchList

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

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:

Find an item in the My eBay Sandbox page: http://sandbox.ebay.com and save the item ID.
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.)
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.
Use RemoveFromWatchList to remove the item from the user's watch list.
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 these calls:

AddToWatchList - Adds one or more items to the user's My eBay watch list.
GetMyeBayBuying - Returns items from the Buying section of the user's My eBay account, including items that the user is watching, bidding on, has won, has not won, and has made Best Offers on.
GetMyeBaySelling - Returns items from the Selling section of the user's My eBay account, including items that the user is currently selling (the Active list), items that have bids, sold items, and unsold items.

RemoveFromWatchList Input

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 Samples.

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>

Argument	Type	Occurrence	Meaning

Call-specific Input Fields [Jump to standard fields]

ItemID	ItemIDType (string)	Conditional, repeatable: [0..*]	The ID of the item to be removed from the watch list. Either ItemID, RemoveAllItems, or VariationKey must be specified, but NOT more than one of these. Multiple ItemID fields can be specified in the same request. Max length: 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits).
RemoveAllItems	boolean	Conditional	If true, then all the items in the user's watch list are removed. Either ItemID, RemoveAllItems, or VariationKey must be specified, but NOT more than one of these.
VariationKey	VariationKeyType	Conditional, repeatable: [0..*]	A variation (or set of variations) that you want to remove from the watch list. Either ItemID, RemoveAllItems, or VariationKey must be specified, but NOT more than one of these.
VariationKey.ItemID	ItemIDType (string)	Conditional	The ID of the item whose variation(s) should be added to or removed from the watch list. Max length: 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits).
VariationKey .VariationSpecifics	NameValueListArrayType	Conditional	Name-value pairs that identify a variation within the listing identified by VariationKey.ItemID. or that partially match one or more variations. Names may not be duplicated in the same VariationSpecifics container. If the specified pairs do not match any variation, the call behaves as if no variations were specified.
VariationKey .VariationSpecifics .NameValueList	NameValueListType	Conditional, repeatable: [0..*]	For the AddItem family of calls: Contains the name and value(s) for an Item Specific. Only required when the ItemSpecifics container is specified. For the AddFixedPriceItem family of calls: The same NameValueList schema is used for the ItemSpecifics node, the VariationSpecifics node, and the VariationSpecifcsSet node. If the listing has varations, any name that you use in the VariationSpecifics and VariationSpecificsSet nodes can't be used in the ItemSpecifics node. When you list with Item Variations: a) Specify shared Item Specifics (e.g., Brand) in the ItemSpecifics node. b) Specify up to five VariationSpecifics in each Variation node. c) Specify all applicable names with all their supported values in the VariationSpecificSet node. See the Variation sample in the AddFixedPriceItem call reference for examples. For PlaceOffer: Required if the item being purchased includes Item Variations.
VariationKey .VariationSpecifics .NameValueList.Name	string	Conditional	A name in a name/value pair. For the AddItem and AddFixedPriceItem families of calls: In the Item.ItemSpecifics context, this can be any name that the seller wants to use. However, to help buyers find items more easily, it is a good idea to try to use a recommended name when possible (see GetCategorySpecifics or GetItemRecommendations). You can't specify the same name twice within the same listing. For the AddFixedPriceItem family of calls: In the VariationSpecifics context, this can be any name that the seller wants to use, unless the VariationsEnabled flag is false for the name in the GetCategorySpecifics response. For example, for some categories eBay may recommend that you only use "Brand" as a shared name at the Item level, not in variations. For GetCategorySpecifics and GetItemRecommendations: This is a recommended (popular) name to use for items in the specified category (e.g., "Brand" might be recommended, not "Manufacturer"). For PlaceOffer: Required if the item being purchased includes Item Variations. Max length: 40.
VariationKey .VariationSpecifics .NameValueList.Value	string	Conditional, repeatable: [0..*]	A value associated with the name. For the AddItem family of calls: If you specify multiple values for Item Specifics, eBay only stores the first one, unless GetCategorySpecifics or GetItemRecommendations indicates that the corresponding name supports multiple values. For the AddFixedPriceItem family of calls: If you specify multiple values for Item Specifics or Variation Specifics, eBay only stores the first one, unless GetCategorySpecifics or GetItemRecommendations indicates that the corresponding name supports multiple values. In VariationSpecificSet, you typically specify multiple Value fields for each name. For example, if Name=Size, you would specify all size values that you wan to offer in the listing. For GetCategorySpecifics and GetItemRecommendations: The most highly recommended values are returned first. For these calls, Value is only returned when recommended values are available. For PlaceOffer: Required if the item being purchased includes Item Variations. Max length: 50.

Standard Input Fields

ErrorLanguage	string	Optional	Use ErrorLanguage to return error strings for the call in a different language from the language commonly associated with the site that the requesting user is registered with. Specify the standard RFC 3066 language identification tag (e.g., en_US). ID--- country ----- ----- de_AT Austria de_CH Switzerland de_DE Germany en_AU Australia en_CA Canada en_GB United Kingdom en_SG Singapore en_US United States es_ES Spain fr_BE Belgium (French) fr_CA Canada (French) fr_FR France it_IT Italy nl_BE Belgium (Dutch) nl_NL Netherlands zh_CN China en_IN India en_IE Ireland zh_HK Hong Kong See Tags for the Identification of Languages.
MessageID	string	Optional	Most Trading API calls support a MessageID element in the request and a CorrelationID element in the response. If you pass in a MessageID in a request, the same value will be returned in the CorrelationID field in the response. Pairing these values can help you track and confirm that a response is returned for every request and to match specific responses to specific requests. If you do not pass a MessageID value in the request, CorrelationID is not returned. Note: GetCategories is designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, the MessageID and CorrelationID fields aren't applicable. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, MessageID and CorrelationID are applicable.
Version	string	Conditional	The version number of the API code that you are programming against (e.g., 549). The version you specify for a call has these basic effects: - It indicates the version of the code lists and other data that eBay should use to process your request. - It indicates the schema version you are using. You need to use a version that is greater than or equal to the lowest supported version. For the SOAP API: If you are using the SOAP API, this field is required. Specify the version of the WSDL your application is using. For the XML API: If you are using the XML API, this field has no effect. Instead, specify the version in the X-EBAY-API-COMPATIBILITY-LEVEL HTTP header. (If you specify Version in the body of an XML API request and it is different from the value in the HTTP header, eBay returns an informational warning that the value in the HTTP header was used instead.) See: Routing the Request (Gateway URLs) eBay Schema Versioning Strategy Lowest Supported Version
WarningLevel	WarningLevelCodeType	Optional	Controls whether or not to return warnings when the application passes unrecognized or deprecated elements in a request. An unrecognized element is one that is not defined in any supported version of the schema. Schema element names are case-sensitive, so using WarningLevel can also help you remove any potential hidden bugs within your application due to incorrect case or spelling in field names before you put your application into the Production environment. WarningLevel only validates elements; it doesn't validate XML attributes. It also doesn't control warnings related to user-entered strings or numbers, or warnings for logical errors. We recommend that you only use this during development and debugging. Do not use this in requests in your production code. Applicable values: • High (in) Return warnings when the application passes unrecognized or deprecated elements in a request. • Low (in) Do not return warnings when the application passes unrecognized or deprecated elements in a request. This is the default value if WarningLevel is not specified. See Warning Level.

RemoveFromWatchList Output

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 Samples.

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>

Return Value	Type	Occurrence	Meaning

Call-specific Output Fields [Jump to standard fields]

WatchListCount	int	Always	The current number of items in the user's watch list (after those specified in the call request have been removed)
WatchListMaximum	int	Always	The maximum number of items allowed in watch lists. Currently this value is 200, and is the same for all sites and all users.

Standard Output Fields

Ack	AckCodeType	Always	A token representing the application-level acknowledgement code that indicates the response status (e.g., success). The AckCodeType list specifies the possible values for Ack. Applicable values: • CustomCode (out) Reserved for internal or future use. • Failure (out) Request processing failed • Success (out) Request processing succeeded • Warning (out) Request processing completed with warning information being included in the response message (Not all values in AckCodeType apply to this field.)
Build	string	Always	This refers to the specific software build that eBay used when processing the request and generating the response. This includes the version number plus additional information. eBay Developer Support may request the build information when helping you resolve technical issues.
CorrelationID	string	Conditionally	Most Trading API calls support a MessageID element in the request and a CorrelationID element in the response. If you pass in a MessageID in a request, the same value will be returned in the CorrelationID field in the response. Pairing these values can help you track and confirm that a response is returned for every request and to match specific responses to specific requests. If you do not pass a MessageID value in the request, CorrelationID is not returned. Note: GetCategories is designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, the MessageID and CorrelationID fields aren't applicable. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, MessageID and CorrelationID are applicable.
Errors	ErrorType	Conditionally, repeatable: [0..*]	A list of application-level errors (if any) that occurred when eBay processed the request. See Error Handling.
Errors.ErrorClassification	ErrorClassificationCodeType	Conditionally	API errors are divided between two classes: system errors and request errors. Applicable values: • CustomCode (out) Reserved for internal or future use. • RequestError (out) An error has occurred either as a result of a problem in the sending application or because the application's end-user has attempted to submit invalid data (or missing data). In these cases, do not retry the request. The problem must be corrected before the request can be made again. If the problem is due to something in the application (such as a missing required field), the application must be changed. If the problem is a result of end-user data, the application must alert the end-user to the problem and provide the means for the end-user to correct the data. Once the problem in the application or data is resolved, resend the request to eBay with the corrected data. • SystemError (out) Indicates that an error has occurred on the eBay system side, such as a database or server down. An application can retry the request as-is a reasonable number of times (eBay recommends twice). If the error persists, contact Developer Technical Support. Once the problem has been resolved, the request may be resent in its original form.
Errors.ErrorCode	token	Conditionally	A unique code that identifies the particular error condition that occurred. Your application can use error codes as identifiers in your customized error-handling algorithms. See the "Errors by Number" document.
Errors.ErrorParameters	ErrorParameterType	Conditionally, repeatable: [0..*]	This optional element carries a list of context-specific error variables that indicate details about the error condition. These are useful when multiple instances of ErrorType are returned.
Errors.ErrorParameters [ attribute ParamID ]	string	Conditionally	The index of the parameter in the list of parameter types returned within the error type.
Errors.ErrorParameters.Value	string	Conditionally	The value of the variable (e.g., the attribute set ID)
Errors.LongMessage	string	Conditionally	A more detailed description of the condition that raised the error.
Errors.SeverityCode	SeverityCodeType	Conditionally	Indicates whether the error is a severe error (causing the request to fail) or an informational error (a warning) that should be communicated to the user. Applicable values: • CustomCode (out) Reserved for internal or future use • Error (out) Application-level error • Warning (out) Warning or informational error
Errors.ShortMessage	string	Conditionally	A brief description of the condition that raised the error.
HardExpirationWarning	string	Conditionally	Expiration date of the user's authentication token. Only returned within the 7-day period prior to a token's expiration. To ensure that user authentication tokens are secure and to help avoid a user's token being compromised, tokens have a limited life span. A token is only valid for a period of time (set by eBay). After this amount of time has passed, the token expires and must be replaced with a new token.
Timestamp	dateTime	Always	This value represents the date and time when eBay processed the request. The time zone of this value is GMT and the format is the ISO 8601 date and time format (YYYY-MM-DDTHH:MM:SS.SSSZ). See Time Values in the eBay Web Services guide for information about this time format and converting to and from the GMT time zone. Note: GetCategories and other Trading API calls are designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, this time value reflects the time the cached response was created. Thus, this value is not necessarily when the request was processed. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, this time value does reflect when the request was processed.
Version	string	Always	The version of the response payload schema. Indicates the version of the schema that eBay used to process the request. See "Standard Data for All Calls" in the eBay Web Services Guide for information on using the response version when troubleshooting "CustomCode" values that appear in the response.

RemoveFromWatchList Detail Controls

Detail Control: DetailLevel

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

RemoveFromWatchList Samples

New to making API calls? Please see Routing the Request.

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.

Sample: Basic Call

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

Description

Bountiful Buyer had placed a coveted First Edition Harry Potter book on her watch list and was eagerly tracking it's bid process. Before she knew what happened, Magical Bookseller had removed the item from the auction (it turns out Magical Bookseller spilled coffee on the book and could no longer sell it for the high price to which it had been bid). With this, Bountiful Buyer no longer needed to track the auction, and she uses RemoveFromWatchList to remove the item from her watch list.

Input

XML format (HTTP POST). Also available is the .txt version of this XML.

<?xml version="1.0" encoding="utf-8"?>
<RemoveFromWatchListRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <RequesterCredentials>
    <eBayAuthToken>ABC...123</eBayAuthToken>
  </RequesterCredentials>
  <ItemID>110043278457</ItemID>
</RemoveFromWatchListRequest>

Output

XML format. Also available is the .txt version of this XML.

<RemoveFromWatchListResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <Timestamp>2010-01-27T23:31:12.187Z</Timestamp>
  <Ack>Success</Ack>
  <Version>643</Version>
  <Build>E643_CORE_BUNDLED_10284414_R1</Build>
  <WatchListCount>5</WatchListCount>
  <WatchListMaximum>200</WatchListMaximum>
</RemoveFromWatchListResponse>

RemoveFromWatchList Change History

Version	Description
615 2008-04-29	VariationKey (added): Removes a variation from a multi-variation listing from the user's watch list.

User-Contributed Notes

eBay Trading API Call Reference Version 821