Website logo

Retrieve the canonical search URL for one of your favourite searches

Retrieves the canonical search URL for one of the currently authenticated user's favourite searches.

URL: https://api.trademe.co.nz/v1/favourites/{favouriteId}/searchurl.{file_format}
HTTP Method: GET
Requires Authentication? Yes
Permission Required: MyTradeMeRead: Read your membership & listing data.
Supported Formats: XML, JSON
Rate Limited? Yes

URL parameters

favouriteId Guid (required)

The Favourites Service GUID of the favourite search.

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

Returns

<FavouriteSearchUrlResponse>

The search URL for the favourite.

Url String or null

The canonical, front-end-relative search URL for the favourite (e.g. "/marketplace/search?...").

Example XML Response (switch to JSON)

<FavouriteSearchUrlResponse xmlns="http://api.trademe.co.nz/v1">
  <Url>ABC</Url>
</FavouriteSearchUrlResponse>

Example JSON Response (switch to XML)

{
  "Url": "ABC"
}