Website logo

Retrieve a list of members for a fixed price offer with the filter

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 Success
Description String or null Description
Watchers Collection of <Member> or null Watchers
MemberId Integer MemberId
Nickname String or null Nickname
DateAddressVerified DateTime DateAddressVerified
DateJoined DateTime DateJoined
UniqueNegative Integer UniqueNegative
UniquePositive Integer UniquePositive
FeedbackCount Integer FeedbackCount
IsAddressVerified Boolean IsAddressVerified
IsDealer Boolean IsDealer
IsAuthenticated Boolean IsAuthenticated
IsBlackListed Boolean IsBlackListed
Bidders Collection of <Member> or null Bidders
(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
    }
  ]
}