Website logo

Retrieve a list of members for a fixed price offer

Returns a list of members you can make a fixed price offer to for a particular auction.

URL: https://api.trademe.co.nz/v1/FixedPriceOffers/{listingId}/Members/{filter}.{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

listingId Integer (required)

The listing ID of the auction you wish to make a fixed price offer for. The listing must be closed.
filter String (required)

Filters the returned list to a subset of possible members ("All", "Bidders" - only return bidders, "Watchers" - only return watchers).
file_format Enumeration (required) The format of the response.
xml Serialize responses into XML.
json Serialize responses into JSON.

Returns

<FixedPriceOfferMembersResponse>

Details on whether the operation was successful.

Success Boolean

Indicates whether the operation was successful.
Description String or null

The description of the error, if the operation failed.
Watchers Collection of <Member> or null

The watchers on the listing
MemberId Integer

The ID of the member. This may be 0, if we determine it is necessary to protect the member's privacy.
Nickname String or null

The nickname of the member. Some characters may be changed, if we determine it is necessary to protect the member's privacy.
DateAddressVerified DateTime

The date the member was address verified.
DateJoined DateTime

The date the member joined.
UniqueNegative Integer

The number of distinct members who have placed negative feedback against this member.
UniquePositive Integer

The number of distinct members who have placed positive feedback against this member.
FeedbackCount Integer

The member's total feedback (UniquePositive minus UniqueNegative).
IsAddressVerified Boolean

Indicates whether the member has been address verified.
IsDealer Boolean

Indicates whether the member is a car dealer.
IsAuthenticated Boolean

Indicates whether the member is authenticated.
IsBlackListed Boolean

Indicates whether the member has been blacklisted.
Bidders Collection of <Member> or null

The bidders on the listing
(This type has already been defined)

Example XML Response (switch to JSON) 

<FixedPriceOfferMembersResponse xmlns="http://api.trademe.co.nz/v1">
  <Success>false</Success>
  <Description>ABC</Description>
  <Watchers>
    <Member>
      <MemberId>123</MemberId>
      <Nickname>ABC</Nickname>
      <DateAddressVerified>2018-01-01T00:00:00Z</DateAddressVerified>
      <DateJoined>2018-01-01T00:00:00Z</DateJoined>
      <UniqueNegative>123</UniqueNegative>
      <UniquePositive>123</UniquePositive>
      <FeedbackCount>123</FeedbackCount>
      <IsAddressVerified>false</IsAddressVerified>
      <IsDealer>false</IsDealer>
      <IsAuthenticated>false</IsAuthenticated>
      <IsBlackListed>false</IsBlackListed>
    </Member>
    <Member>
      <MemberId>123</MemberId>
      <Nickname>ABC</Nickname>
      <DateAddressVerified>2018-01-01T00:00:00Z</DateAddressVerified>
      <DateJoined>2018-01-01T00:00:00Z</DateJoined>
      <UniqueNegative>123</UniqueNegative>
      <UniquePositive>123</UniquePositive>
      <FeedbackCount>123</FeedbackCount>
      <IsAddressVerified>false</IsAddressVerified>
      <IsDealer>false</IsDealer>
      <IsAuthenticated>false</IsAuthenticated>
      <IsBlackListed>false</IsBlackListed>
    </Member>
  </Watchers>
  <Bidders>
    <Member>
      <MemberId>123</MemberId>
      <Nickname>ABC</Nickname>
      <DateAddressVerified>2018-01-01T00:00:00Z</DateAddressVerified>
      <DateJoined>2018-01-01T00:00:00Z</DateJoined>
      <UniqueNegative>123</UniqueNegative>
      <UniquePositive>123</UniquePositive>
      <FeedbackCount>123</FeedbackCount>
      <IsAddressVerified>false</IsAddressVerified>
      <IsDealer>false</IsDealer>
      <IsAuthenticated>false</IsAuthenticated>
    </Member>
    <Member>
      <MemberId>123</MemberId>
      <Nickname>ABC</Nickname>
      <DateAddressVerified>2018-01-01T00:00:00Z</DateAddressVerified>
      <DateJoined>2018-01-01T00:00:00Z</DateJoined>
      <UniqueNegative>123</UniqueNegative>
      <UniquePositive>123</UniquePositive>
      <FeedbackCount>123</FeedbackCount>
      <IsAddressVerified>false</IsAddressVerified>
      <IsDealer>false</IsDealer>
      <IsAuthenticated>false</IsAuthenticated>
    </Member>
  </Bidders>
</FixedPriceOfferMembersResponse>

Example JSON Response (switch to XML) 

{
  "Success": false,
  "Description": "ABC",
  "Watchers": [
    {
      "MemberId": 123,
      "Nickname": "ABC",
      "DateAddressVerified": "\/Date(1514764800)\/",
      "DateJoined": "\/Date(1514764800)\/",
      "UniqueNegative": 123,
      "UniquePositive": 123,
      "FeedbackCount": 123,
      "IsAddressVerified": false,
      "IsDealer": false,
      "IsAuthenticated": false,
      "IsBlackListed": false
    },
    {
      "MemberId": 123,
      "Nickname": "ABC",
      "DateAddressVerified": "\/Date(1514764800)\/",
      "DateJoined": "\/Date(1514764800)\/",
      "UniqueNegative": 123,
      "UniquePositive": 123,
      "FeedbackCount": 123,
      "IsAddressVerified": false,
      "IsDealer": false,
      "IsAuthenticated": false,
      "IsBlackListed": false
    }
  ],
  "Bidders": [
    {
      "MemberId": 123,
      "Nickname": "ABC",
      "DateAddressVerified": "\/Date(1514764800)\/",
      "DateJoined": "\/Date(1514764800)\/",
      "UniqueNegative": 123,
      "UniquePositive": 123,
      "FeedbackCount": 123,
      "IsAddressVerified": false,
      "IsDealer": false,
      "IsAuthenticated": false
    },
    {
      "MemberId": 123,
      "Nickname": "ABC",
      "DateAddressVerified": "\/Date(1514764800)\/",
      "DateJoined": "\/Date(1514764800)\/",
      "UniqueNegative": 123,
      "UniquePositive": 123,
      "FeedbackCount": 123,
      "IsAddressVerified": false,
      "IsDealer": false,
      "IsAuthenticated": false
    }
  ]
}