Website logo

Remove a saved favourite

Deletes a saved search, category or seller from the currently authenticated user's favourites.

URL: https://api.trademe.co.nz/v1/Favourites/{favouriteId}/{type}.{file_format}
HTTP Method: DELETE
Requires Authentication? Yes
Permission Required: MyTradeMeWrite: Maintain your watchlist, answer questions and post comments.
Supported Formats: XML, JSON
Rate Limited? Yes

URL parameters

favouriteId Integer (required)

The ID of the favourite.

type String (required)

The type of favourite (must be "Category", "Search", "AttributeSearch" or "Seller").

file_format Enumeration (required) The format of the response.
xml Serialize responses into XML.
json Serialize responses into JSON.

Returns

<RemovedFavouriteResponse>

Details indicating whether the operation succeeded.

SearchId Integer

The ID of the saved favourite.

Response String or null

A description of the error, if the operation failed.

Removed Boolean

Indicates whether the favourite was removed.

Success Boolean

Indicates whether the operation was successful

Example XML Response (switch to JSON)

<RemovedFavouriteResponse xmlns="http://api.trademe.co.nz/v1">
  <SearchId>123</SearchId>
  <Response>ABC</Response>
  <Removed>false</Removed>
  <Success>false</Success>
</RemovedFavouriteResponse>

Example JSON Response (switch to XML)

{
  "SearchId": 123,
  "Response": "ABC",
  "Removed": false,
  "Success": false
}