Website logo

Retrieve your favourite sellers

Retrieves the list of favourite sellers for the currently authenticated user.

URL: https://api.trademe.co.nz/v1/favourites/sellers.{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

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

Query String parameters

page Integer (optional)

The page number of the set of results to return, starting from 1. Defaults to 1.
rows Integer (optional)

The number of results per page; also the maximum number of results to return. Defaults to all favourites.
with_listing_counts Boolean (optional)

Indicates whether to return the counts of the saved sellers' current listings. Defaults to true.

Returns

<SavedSellers>

A list of favourite sellers.

TotalCount Integer TotalCount
Page Integer Page
PageSize Integer PageSize
List Collection of <SavedSeller> or null InnerList
FavouriteId Integer FavouriteId
SearchApi Enumeration SearchApi
General 0 General
UsedMotors 1 UsedMotors
MotorBoat 2 MotorBoat
MotorBike 3 MotorBike
Residential 4 Residential
Rental 5 Rental
CommercialSale 6 CommercialSale
CommercialLease 7 CommercialLease
Rural 8 Rural
Lifestyle 9 Lifestyle
Flatmate 10 Flatmate
OpenHomes 11 OpenHomes
Retirement 12 Retirement
Job 13 Job
NewHomes 14 NewHomes
Caravan 15 Caravan
Motorhome 16 Motorhome
SearchString String or null SearchString
Attributes <SearchAttributes> or null Attributes
TotalCount Integer TotalCount
Page Integer Page
PageSize Integer PageSize
List Collection of <SearchAttribute> or null InnerList
Name String or null Name
DisplayName String or null DisplayName
Value String or null Value
DisplayValue String or null DisplayValue
SearchParameterName String or null SearchParameterName
EmailOptions Enumeration EmailOptions
None 0 None
Daily 1 Daily
Every3Days 3 Every3Days
Weekly 7 Weekly
Option Enumeration Option
None 0 None
Category 1 Category
Search 3 Search
AttributeSearch 4 AttributeSearch
Seller 6 Seller
LastAccessed DateTime or null LastAccessed
FavouritePushFrequency Enumeration FavouritePushFrequency
None 0 None
Instant 1 Instant
MemberId Integer MemberId
Nickname String or null Nickname
DateJoined DateTime DateJoined
UniqueNegative Integer UniqueNegative
UniquePositive Integer UniquePositive
FeedbackCount Integer FeedbackCount
IsAddressVerified Boolean IsAddressVerified
CurrentListingCount Integer CurrentListingCount
Suburb String or null Suburb
IsDealer Boolean IsDealer
IsInTrade Boolean IsInTrade
IsAuthenticated Boolean IsAuthenticated

Example XML Response (switch to JSON) 

<SavedSellers xmlns="http://api.trademe.co.nz/v1">
  <TotalCount>123</TotalCount>
  <Page>123</Page>
  <PageSize>123</PageSize>
  <List>
    <SavedSeller>
      <FavouriteId>123</FavouriteId>
      <SearchApi>General</SearchApi>
      <SearchString>ABC</SearchString>
      <Attributes>
        <TotalCount>123</TotalCount>
        <Page>123</Page>
        <PageSize>123</PageSize>
        <List>
          <SearchAttribute>
            <Name>ABC</Name>
            <DisplayName>ABC</DisplayName>
            <Value>ABC</Value>
            <DisplayValue>ABC</DisplayValue>
            <SearchParameterName>ABC</SearchParameterName>
          </SearchAttribute>
          <SearchAttribute>
            <Name>ABC</Name>
            <DisplayName>ABC</DisplayName>
            <Value>ABC</Value>
            <DisplayValue>ABC</DisplayValue>
            <SearchParameterName>ABC</SearchParameterName>
          </SearchAttribute>
        </List>
      </Attributes>
      <EmailOptions>None</EmailOptions>
      <Option>None</Option>
      <LastAccessed>2018-01-01T00:00:00Z</LastAccessed>
      <FavouritePushFrequency>None</FavouritePushFrequency>
      <MemberId>123</MemberId>
      <Nickname>ABC</Nickname>
      <DateJoined>2018-01-01T00:00:00Z</DateJoined>
      <UniqueNegative>123</UniqueNegative>
      <UniquePositive>123</UniquePositive>
      <FeedbackCount>123</FeedbackCount>
      <IsAddressVerified>false</IsAddressVerified>
      <CurrentListingCount>123</CurrentListingCount>
      <Suburb>ABC</Suburb>
      <IsDealer>false</IsDealer>
      <IsInTrade>false</IsInTrade>
      <IsAuthenticated>false</IsAuthenticated>
    </SavedSeller>
    <SavedSeller>
      <FavouriteId>123</FavouriteId>
      <SearchApi>General</SearchApi>
      <SearchString>ABC</SearchString>
      <Attributes>
        <TotalCount>123</TotalCount>
        <Page>123</Page>
        <PageSize>123</PageSize>
        <List>
          <SearchAttribute>
            <Name>ABC</Name>
            <DisplayName>ABC</DisplayName>
            <Value>ABC</Value>
            <DisplayValue>ABC</DisplayValue>
            <SearchParameterName>ABC</SearchParameterName>
          </SearchAttribute>
          <SearchAttribute>
            <Name>ABC</Name>
            <DisplayName>ABC</DisplayName>
            <Value>ABC</Value>
            <DisplayValue>ABC</DisplayValue>
            <SearchParameterName>ABC</SearchParameterName>
          </SearchAttribute>
        </List>
      </Attributes>
      <EmailOptions>None</EmailOptions>
      <Option>None</Option>
      <LastAccessed>2018-01-01T00:00:00Z</LastAccessed>
      <FavouritePushFrequency>None</FavouritePushFrequency>
      <MemberId>123</MemberId>
      <Nickname>ABC</Nickname>
      <DateJoined>2018-01-01T00:00:00Z</DateJoined>
      <UniqueNegative>123</UniqueNegative>
      <UniquePositive>123</UniquePositive>
      <FeedbackCount>123</FeedbackCount>
      <IsAddressVerified>false</IsAddressVerified>
      <CurrentListingCount>123</CurrentListingCount>
      <Suburb>ABC</Suburb>
      <IsDealer>false</IsDealer>
      <IsInTrade>false</IsInTrade>
      <IsAuthenticated>false</IsAuthenticated>
    </SavedSeller>
  </List>
</SavedSellers>

Example JSON Response (switch to XML) 

{
  "TotalCount": 123,
  "Page": 123,
  "PageSize": 123,
  "List": [
    {
      "FavouriteId": 123,
      "SearchApi": 0,
      "SearchString": "ABC",
      "Attributes": {
        "TotalCount": 123,
        "Page": 123,
        "PageSize": 123,
        "List": [
          {
            "Name": "ABC",
            "DisplayName": "ABC",
            "Value": "ABC",
            "DisplayValue": "ABC",
            "SearchParameterName": "ABC"
          },
          {
            "Name": "ABC",
            "DisplayName": "ABC",
            "Value": "ABC",
            "DisplayValue": "ABC",
            "SearchParameterName": "ABC"
          }
        ]
      },
      "EmailOptions": 0,
      "Option": 0,
      "LastAccessed": "\/Date(1514764800)\/",
      "FavouritePushFrequency": 0,
      "MemberId": 123,
      "Nickname": "ABC",
      "DateJoined": "\/Date(1514764800)\/",
      "UniqueNegative": 123,
      "UniquePositive": 123,
      "FeedbackCount": 123,
      "IsAddressVerified": false,
      "CurrentListingCount": 123,
      "Suburb": "ABC",
      "IsDealer": false,
      "IsInTrade": false,
      "IsAuthenticated": false
    },
    {
      "FavouriteId": 123,
      "SearchApi": 0,
      "SearchString": "ABC",
      "Attributes": {
        "TotalCount": 123,
        "Page": 123,
        "PageSize": 123,
        "List": [
          {
            "Name": "ABC",
            "DisplayName": "ABC",
            "Value": "ABC",
            "DisplayValue": "ABC",
            "SearchParameterName": "ABC"
          },
          {
            "Name": "ABC",
            "DisplayName": "ABC",
            "Value": "ABC",
            "DisplayValue": "ABC",
            "SearchParameterName": "ABC"
          }
        ]
      },
      "EmailOptions": 0,
      "Option": 0,
      "LastAccessed": "\/Date(1514764800)\/",
      "FavouritePushFrequency": 0,
      "MemberId": 123,
      "Nickname": "ABC",
      "DateJoined": "\/Date(1514764800)\/",
      "UniqueNegative": 123,
      "UniquePositive": 123,
      "FeedbackCount": 123,
      "IsAddressVerified": false,
      "CurrentListingCount": 123,
      "Suburb": "ABC",
      "IsDealer": false,
      "IsInTrade": false,
      "IsAuthenticated": false
    }
  ]
}