Website logo

Retrieve member selling preferences

Retrieves the selling preferences of the authenticated member

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

Returns

<SellingPreferences>

The selling preferences.

OnlyAuthenticatedMembersCanBid Boolean

Determines if only authenticated members can bid on the listings. Only applicable to auctions, ignored for classifieds.

DonationRecipient Integer or null

Indicates the user would like to round up their success fees to the nearest dollar and donate the difference to the selected charity.

ShowPickUpLocation Boolean

Determines if the listings with pick-up option will be available for Sell Local. When true, the three-tier region/district/suburb location will be displayed for listings with pick-up option. Only applicable to auctions, ignored for classifieds.

PickUpLocation <SellingPreferencesPickUpLocation> or null

The pick-up three-tier region/district/suburb location info to be displayed when Sell Local is enabled (ShowPickUpLocation is true). Only applicable to auctions, ignored for classifieds.

SuburbId Integer

The pick-up suburb id

SuburbName String or null

The pick-up suburb name

DistrictId Integer

The pick-up district id

DistrictName String or null

The pick-up district name

RegionId Integer

The pick-up region id

RegionName String or null

The pick-up region name

Example XML Response (switch to JSON)

<SellingPreferences xmlns="http://api.trademe.co.nz/v1">
  <OnlyAuthenticatedMembersCanBid>false</OnlyAuthenticatedMembersCanBid>
  <DonationRecipient>123</DonationRecipient>
  <ShowPickUpLocation>false</ShowPickUpLocation>
  <PickUpLocation>
    <SuburbId>123</SuburbId>
    <SuburbName>ABC</SuburbName>
    <DistrictId>123</DistrictId>
    <DistrictName>ABC</DistrictName>
    <RegionId>123</RegionId>
    <RegionName>ABC</RegionName>
  </PickUpLocation>
</SellingPreferences>

Example JSON Response (switch to XML)

{
  "OnlyAuthenticatedMembersCanBid": false,
  "DonationRecipient": 123,
  "ShowPickUpLocation": false,
  "PickUpLocation": {
    "SuburbId": 123,
    "SuburbName": "ABC",
    "DistrictId": 123,
    "DistrictName": "ABC",
    "RegionId": 123,
    "RegionName": "ABC"
  }
}