• Home >
• API Reference >
• Favourite Methods >
• Save a search, category or seller to your favourites

Save a search, category or seller to your favourites

Saves a search to the currently authenticated user's list of favourite searches. Can also be used to save a favourite category or seller with the option of specifying basic filters (condition, Buy Now, Pay Now) and sort order.

URL parameters

POST Data

<SaveSearchRequest>

Returns

<SavedFavouriteResponse>

Details of the saved favourite, including the ID.

Examples

Example of a saving a simple keyword search:

<SaveSearchRequest xmlns="http://api.trademe.co.nz/v1">
  <Email>None</Email>
  <SearchString>search_string=Karen%20Walker</SearchString>
  <Type>General</Type>
</SaveSearchRequest>

Example of a saving a simple keyword search sorted by highest number of bids:

<SaveSearchRequest xmlns="http://api.trademe.co.nz/v1">
  <Email>None</Email>
  <SearchString>search_string=Karen%20Walker&amp;sort_order=BidsMost</SearchString>
  <Type>General</Type>
</SaveSearchRequest>

Example of a saving a motors search with price range and automatic transmission filters:

<SaveSearchRequest xmlns="http://api.trademe.co.nz/v1">
  <Email>None</Email>
  <SearchString>price_min=20000&amp;price_max=30000&amp;transmission=Automatic</SearchString>
  <Type>UsedMotors</Type>
</SaveSearchRequest>

Example of a saving a category (with a daily email):

<SaveSearchRequest xmlns="http://api.trademe.co.nz/v1">
  <Email>Daily</Email>
  <SearchString>category=4295</SearchString>
  <Type>General</Type>
</SaveSearchRequest>

Example of saving a category with a region filter:

<SaveSearchRequest xmlns="http://api.trademe.co.nz/v1">
  <Email>None</Email>
  <SearchString>category=4295&amp;user_region=12</SearchString>
  <Type>General</Type>
</SaveSearchRequest>

Example of a saving a seller (with a weekly email):

<SaveSearchRequest xmlns="http://api.trademe.co.nz/v1">
  <Email>Weekly</Email>
  <SearchString>member_listing=158286</SearchString>
  <Type>General</Type>
</SaveSearchRequest>

Example of saving a seller with a Buy Now filter:

<SaveSearchRequest xmlns="http://api.trademe.co.nz/v1">
  <Email>None</Email>
  <SearchString>member_listing=158286&amp;buy=BuyNow</SearchString>
  <Type>General</Type>
</SaveSearchRequest>

<SaveSearchRequest xmlns="http://api.trademe.co.nz/v1">
  <Email>None</Email>
  <Push>None</Push>
  <SearchString>ABC</SearchString>
  <Type>General</Type>
</SaveSearchRequest>

{
  "Email": 0,
  "Push": 0,
  "SearchString": "ABC",
  "Type": 0
}

<SavedFavouriteResponse xmlns="http://api.trademe.co.nz/v1">
  <SearchId>123</SearchId>
  <Response>ABC</Response>
  <Saved>false</Saved>
  <FavouriteType>None</FavouriteType>
</SavedFavouriteResponse>

{
  "SearchId": 123,
  "Response": "ABC",
  "Saved": false,
  "FavouriteType": 0
}