Website logo

Retrieve your profile information

Retrieves full statistics and profile information for the authenticated user.

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

return_member_profile Boolean (optional)

If true, also returns the member's public profile information (occupation, bio, photo, etc).

Returns

<MemberSummary>

The user's name, email address, bought, sold and feedback stats.

WatchListCount Integer WatchListCount
WonCount Integer WonCount
LostCount Integer LostCount
SellingCount Integer SellingCount
SoldCount Integer SoldCount
UnsoldCount Integer UnsoldCount
PositiveFeedback Integer PositiveFeedback
NegativeFeedback Integer NegativeFeedback
TotalFeedback Integer TotalFeedback
MemberId Integer MemberId
Nickname String or null Nickname
DateJoined DateTime DateJoined
DateAddressVerified DateTime DateAddressVerified
IsAddressVerified Boolean IsAddressVerified
Balance Number Balance
PayNowBalance Number PayNowBalance
FirstName String or null FirstName
LastName String or null LastName
FixedPriceOffers Integer FixedPriceOffers
Email String or null Email
Gender Enumeration Gender
Unspecified 0 Unspecified
Male 1 Male
Female 2 Female
DiverseGender 3 DiverseGender
MembershipAddress <DeliveryAddress> or null MembershipAddress
Name String or null Name
Address1 String or null Address1
Address2 String or null Address2
Suburb String or null Suburb
City String or null City
Postcode String or null Postcode
Country String or null Country
IsMembershipAddress Boolean IsMembershipAddress
IsBusiness Boolean IsBusiness
BusinessName String or null BusinessName
BillingAddress <DeliveryAddress> or null BillingAddress
(This type has already been defined)
ClosestLocality String or null ClosestLocality
ClosestDistrict String or null ClosestDistrict
ClosestDistrictId Integer ClosestDistrictId
IsAuthenticated Boolean IsAuthenticated
IsPayNowAccepted Boolean IsPayNowAccepted
FavouriteSearchCount Integer FavouriteSearchCount
FavouriteCategoryCount Integer FavouriteCategoryCount
FavouriteSellerCount Integer FavouriteSellerCount
AutoBillingEnabled Boolean AutoBillingEnabled
CanListClearanceItems Boolean CanListClearanceItems
IsTopSeller Boolean IsTopSeller
IsRegisteredWineSeller Boolean IsRegisteredWineSeller
IsPropertyAgent Boolean IsPropertyAgent
IsRentalAgent Boolean IsRentalAgent
IsJobAgent Boolean IsJobAgent
CreditCardType String or null CreditCardType
CreditCardLastFourDigits String or null CreditCardLastFourDigits
CreditCardExpiryMonth Integer CreditCardExpiryMonth
CreditCardExpiryYear Integer CreditCardExpiryYear
RecentSearchesEnabled Boolean RecentSearchesEnabled
HighVolumeListingCount Integer HighVolumeListingCount
HighVolumeThreshold Integer HighVolumeThreshold
CanRemoveBids Boolean CanRemoveBids

This field will always return true.

ShoppingCartCount Integer ShoppingCartCount
IsInTrade Boolean IsInTrade
MemberProfile <SimpleMemberProfile> or null MemberProfile
Occupation String or null Occupation
Biography String or null Biography
Quote String or null Quote
Photo String or null Photo
ExternalTrackingToken String or null ExternalTrackingToken
LandlinePhoneNumber String or null LandlinePhoneNumber
MobilePhoneNumber String or null MobilePhoneNumber
MemberToken String or null MemberToken
TradevineAccountType Enumeration TradevineAccountType
NotRegistered 0 NotRegistered
TradevineLite 1 TradevineLite
Tradevine 2 Tradevine
NewGoodsFeed 3 NewGoodsFeed
TradeRunner 4 TradeRunner
DraftSummary <DraftSummary> or null DraftSummary
DraftCount Integer DraftCount
DraftLimit Integer DraftLimit
JobProfiles Collection of <JobProfileSummary> or null JobProfiles
ProfileId Integer ProfileId
Key String or null Key
AvailableExternalPaymentProviders Collection of Enumeration or null AvailableExternalPaymentProviders
MemberTokens Collection of <MemberToken> or null MemberTokens
Service Enumeration Service
None 0 None
Sentry 1 Sentry
GoogleAnalytics 2 GoogleAnalytics
ExternalSearch 3 ExternalSearch
ListingCollections 4 ListingCollections
InternalServices 6 InternalServices
Token Guid Token
LoyaltySubscriptionDetails <MemberLoyaltySubscriptionDetails> or null LoyaltySubscriptionDetails
IsMemberEligibleForNewSubscription Boolean IsMemberEligibleForNewSubscription
Subscription <LoyaltySubscriptionDetail> or null Subscription
Id Integer Id
Status Enumeration Status
NotSubscribed 0 NotSubscribed
Active 1 Active
Expired 2 Expired
SubscribedAt DateTime SubscribedAt
ExpiresAt DateTime ExpiresAt
Product <LoyaltyProductDetail> or null Product
Id Integer Id

This field is deprecated.

Price Number Price

This field is deprecated.

PaymentInterval <LoyaltyPaymentIntervalDetail> or null PaymentInterval

This field is deprecated.

Description String or null Description

This field is deprecated.

IntervalType Enumeration IntervalType

This field is deprecated.

Once 0 Once
Week 1 Week
Month 2 Month
IntervalsPerPayment Integer IntervalsPerPayment

This field is deprecated.

Benefits Collection of <LoyaltyBenefitDetail> or null Benefits

This field is deprecated.

Type Enumeration Type

This field is deprecated.

Unknown 0 Unknown
FreeShipping 1 FreeShipping
FreeSuccessFee 2 FreeSuccessFee
SubsidyLimit Number SubsidyLimit

This field is deprecated.

IsUnlimited Boolean or null IsUnlimited

This field is deprecated.

Quota Integer or null Quota

This field is deprecated.

QuotaRemaining Integer or null QuotaRemaining

This field is deprecated.

TaxLiabilities Collection of <TaxRate> or null TaxLiabilities
Type Enumeration Type
NZ_GST_Overseas_Supplies 1 NZ_GST_Overseas_Supplies
Country String or null Country
Name String or null Name
FlatRate Number FlatRate
Description String or null Description
IsSellRestrictionsEffective Boolean IsSellRestrictionsEffective
IsTaxEffective Boolean IsTaxEffective
Location <MapPoint> or null Location
Latitude Number Latitude
Longitude Number Longitude
PayNowStatus Enumeration PayNowStatus
Unknown 0 Unknown
NotRegistered 1 NotRegistered
PendingFirstActivation 2 PendingFirstActivation
ActivePendingReplacementActivation 3 ActivePendingReplacementActivation
Active 4 Active
Suspended 5 Suspended
Bounced 6 Bounced
BouncedPendingReplacementActivation 7 BouncedPendingReplacementActivation
SegmentUserId String or null SegmentUserId
IsBasic Boolean IsBasic

Example XML Response (switch to JSON)

<MemberSummary xmlns="http://api.trademe.co.nz/v1">
  <WatchListCount>123</WatchListCount>
  <WonCount>123</WonCount>
  <LostCount>123</LostCount>
  <SellingCount>123</SellingCount>
  <SoldCount>123</SoldCount>
  <UnsoldCount>123</UnsoldCount>
  <PositiveFeedback>123</PositiveFeedback>
  <NegativeFeedback>123</NegativeFeedback>
  <TotalFeedback>123</TotalFeedback>
  <MemberId>123</MemberId>
  <Nickname>ABC</Nickname>
  <DateJoined>2018-01-01T00:00:00Z</DateJoined>
  <DateAddressVerified>2018-01-01T00:00:00Z</DateAddressVerified>
  <IsAddressVerified>false</IsAddressVerified>
  <Balance>123.0</Balance>
  <PayNowBalance>123.0</PayNowBalance>
  <FirstName>ABC</FirstName>
  <LastName>ABC</LastName>
  <FixedPriceOffers>123</FixedPriceOffers>
  <Email>ABC</Email>
  <Gender>Unspecified</Gender>
  <MembershipAddress>
    <Name>ABC</Name>
    <Address1>ABC</Address1>
    <Address2>ABC</Address2>
    <Suburb>ABC</Suburb>
    <City>ABC</City>
    <Postcode>ABC</Postcode>
    <Country>ABC</Country>
    <IsMembershipAddress>false</IsMembershipAddress>
  </MembershipAddress>
  <IsBusiness>false</IsBusiness>
  <BusinessName>ABC</BusinessName>
  <BillingAddress>
    <Name>ABC</Name>
    <Address1>ABC</Address1>
    <Address2>ABC</Address2>
    <Suburb>ABC</Suburb>
    <City>ABC</City>
    <Postcode>ABC</Postcode>
    <Country>ABC</Country>
  </BillingAddress>
  <ClosestLocality>ABC</ClosestLocality>
  <ClosestDistrict>ABC</ClosestDistrict>
  <ClosestDistrictId>123</ClosestDistrictId>
  <IsAuthenticated>false</IsAuthenticated>
  <IsPayNowAccepted>false</IsPayNowAccepted>
  <FavouriteSearchCount>123</FavouriteSearchCount>
  <FavouriteCategoryCount>123</FavouriteCategoryCount>
  <FavouriteSellerCount>123</FavouriteSellerCount>
  <AutoBillingEnabled>false</AutoBillingEnabled>
  <CanListClearanceItems>false</CanListClearanceItems>
  <IsTopSeller>false</IsTopSeller>
  <IsRegisteredWineSeller>false</IsRegisteredWineSeller>
  <IsPropertyAgent>false</IsPropertyAgent>
  <IsRentalAgent>false</IsRentalAgent>
  <IsJobAgent>false</IsJobAgent>
  <CreditCardType>ABC</CreditCardType>
  <CreditCardLastFourDigits>ABC</CreditCardLastFourDigits>
  <CreditCardExpiryMonth>123</CreditCardExpiryMonth>
  <CreditCardExpiryYear>123</CreditCardExpiryYear>
  <RecentSearchesEnabled>false</RecentSearchesEnabled>
  <HighVolumeListingCount>123</HighVolumeListingCount>
  <HighVolumeThreshold>123</HighVolumeThreshold>
  <CanRemoveBids>false</CanRemoveBids>
  <ShoppingCartCount>123</ShoppingCartCount>
  <IsInTrade>false</IsInTrade>
  <MemberProfile>
    <Occupation>ABC</Occupation>
    <Biography>ABC</Biography>
    <Quote>ABC</Quote>
    <Photo>ABC</Photo>
  </MemberProfile>
  <ExternalTrackingToken>ABC</ExternalTrackingToken>
  <LandlinePhoneNumber>ABC</LandlinePhoneNumber>
  <MobilePhoneNumber>ABC</MobilePhoneNumber>
  <MemberToken>ABC</MemberToken>
  <TradevineAccountType>NotRegistered</TradevineAccountType>
  <DraftSummary>
    <DraftCount>123</DraftCount>
    <DraftLimit>123</DraftLimit>
  </DraftSummary>
  <JobProfiles>
    <JobProfileSummary>
      <ProfileId>123</ProfileId>
      <Key>ABC</Key>
    </JobProfileSummary>
    <JobProfileSummary>
      <ProfileId>123</ProfileId>
      <Key>ABC</Key>
    </JobProfileSummary>
  </JobProfiles>
  <AvailableExternalPaymentProviders>
    <ExternalPaymentProvider>Afterpay</ExternalPaymentProvider>
    <ExternalPaymentProvider>Afterpay</ExternalPaymentProvider>
  </AvailableExternalPaymentProviders>
  <MemberTokens>
    <MemberToken>
      <Service>None</Service>
      <Token>ABCDEF12-0123-4567-ABBA-01234567ABCD</Token>
    </MemberToken>
    <MemberToken>
      <Service>None</Service>
      <Token>ABCDEF12-0123-4567-ABBA-01234567ABCD</Token>
    </MemberToken>
  </MemberTokens>
  <LoyaltySubscriptionDetails>
    <IsMemberEligibleForNewSubscription>false</IsMemberEligibleForNewSubscription>
    <Subscription>
      <Id>123</Id>
      <Status>NotSubscribed</Status>
      <SubscribedAt>2018-01-01T00:00:00Z</SubscribedAt>
      <ExpiresAt>2018-01-01T00:00:00Z</ExpiresAt>
      <Product>
        <Id>123</Id>
        <Price>123.0</Price>
        <PaymentInterval>
          <Description>ABC</Description>
          <IntervalType>Once</IntervalType>
          <IntervalsPerPayment>123</IntervalsPerPayment>
        </PaymentInterval>
        <Benefits>
          <LoyaltyBenefitDetail>
            <Type>Unknown</Type>
            <SubsidyLimit>123.0</SubsidyLimit>
            <IsUnlimited>false</IsUnlimited>
            <Quota>123</Quota>
            <QuotaRemaining>123</QuotaRemaining>
          </LoyaltyBenefitDetail>
          <LoyaltyBenefitDetail>
            <Type>Unknown</Type>
            <SubsidyLimit>123.0</SubsidyLimit>
            <IsUnlimited>false</IsUnlimited>
            <Quota>123</Quota>
            <QuotaRemaining>123</QuotaRemaining>
          </LoyaltyBenefitDetail>
        </Benefits>
      </Product>
    </Subscription>
  </LoyaltySubscriptionDetails>
  <TaxLiabilities>
    <TaxRate>
      <Type>NZ_GST_Overseas_Supplies</Type>
      <Country>ABC</Country>
      <Name>ABC</Name>
      <FlatRate>123.0</FlatRate>
      <Description>ABC</Description>
      <IsSellRestrictionsEffective>false</IsSellRestrictionsEffective>
      <IsTaxEffective>false</IsTaxEffective>
    </TaxRate>
    <TaxRate>
      <Type>NZ_GST_Overseas_Supplies</Type>
      <Country>ABC</Country>
      <Name>ABC</Name>
      <FlatRate>123.0</FlatRate>
      <Description>ABC</Description>
      <IsSellRestrictionsEffective>false</IsSellRestrictionsEffective>
      <IsTaxEffective>false</IsTaxEffective>
    </TaxRate>
  </TaxLiabilities>
  <Location>
    <Latitude>123.0</Latitude>
    <Longitude>123.0</Longitude>
  </Location>
  <PayNowStatus>Unknown</PayNowStatus>
  <SegmentUserId>ABC</SegmentUserId>
  <IsBasic>false</IsBasic>
</MemberSummary>

Example JSON Response (switch to XML)

{
  "WatchListCount": 123,
  "WonCount": 123,
  "LostCount": 123,
  "SellingCount": 123,
  "SoldCount": 123,
  "UnsoldCount": 123,
  "PositiveFeedback": 123,
  "NegativeFeedback": 123,
  "TotalFeedback": 123,
  "MemberId": 123,
  "Nickname": "ABC",
  "DateJoined": "\/Date(1514764800)\/",
  "DateAddressVerified": "\/Date(1514764800)\/",
  "IsAddressVerified": false,
  "Balance": 123.0,
  "PayNowBalance": 123.0,
  "FirstName": "ABC",
  "LastName": "ABC",
  "FixedPriceOffers": 123,
  "Email": "ABC",
  "Gender": 0,
  "MembershipAddress": {
    "Name": "ABC",
    "Address1": "ABC",
    "Address2": "ABC",
    "Suburb": "ABC",
    "City": "ABC",
    "Postcode": "ABC",
    "Country": "ABC",
    "IsMembershipAddress": false
  },
  "IsBusiness": false,
  "BusinessName": "ABC",
  "BillingAddress": {
    "Name": "ABC",
    "Address1": "ABC",
    "Address2": "ABC",
    "Suburb": "ABC",
    "City": "ABC",
    "Postcode": "ABC",
    "Country": "ABC"
  },
  "ClosestLocality": "ABC",
  "ClosestDistrict": "ABC",
  "ClosestDistrictId": 123,
  "IsAuthenticated": false,
  "IsPayNowAccepted": false,
  "FavouriteSearchCount": 123,
  "FavouriteCategoryCount": 123,
  "FavouriteSellerCount": 123,
  "AutoBillingEnabled": false,
  "CanListClearanceItems": false,
  "IsTopSeller": false,
  "IsRegisteredWineSeller": false,
  "IsPropertyAgent": false,
  "IsRentalAgent": false,
  "IsJobAgent": false,
  "CreditCardType": "ABC",
  "CreditCardLastFourDigits": "ABC",
  "CreditCardExpiryMonth": 123,
  "CreditCardExpiryYear": 123,
  "RecentSearchesEnabled": false,
  "HighVolumeListingCount": 123,
  "HighVolumeThreshold": 123,
  "CanRemoveBids": false,
  "ShoppingCartCount": 123,
  "IsInTrade": false,
  "MemberProfile": {
    "Occupation": "ABC",
    "Biography": "ABC",
    "Quote": "ABC",
    "Photo": "ABC"
  },
  "ExternalTrackingToken": "ABC",
  "LandlinePhoneNumber": "ABC",
  "MobilePhoneNumber": "ABC",
  "MemberToken": "ABC",
  "TradevineAccountType": 0,
  "DraftSummary": {
    "DraftCount": 123,
    "DraftLimit": 123
  },
  "JobProfiles": [
    {
      "ProfileId": 123,
      "Key": "ABC"
    },
    {
      "ProfileId": 123,
      "Key": "ABC"
    }
  ],
  "AvailableExternalPaymentProviders": [
    1,
    1
  ],
  "MemberTokens": [
    {
      "Service": 0,
      "Token": "ABCDEF12-0123-4567-ABBA-01234567ABCD"
    },
    {
      "Service": 0,
      "Token": "ABCDEF12-0123-4567-ABBA-01234567ABCD"
    }
  ],
  "LoyaltySubscriptionDetails": {
    "IsMemberEligibleForNewSubscription": false,
    "Subscription": {
      "Id": 123,
      "Status": 0,
      "SubscribedAt": "\/Date(1514764800)\/",
      "ExpiresAt": "\/Date(1514764800)\/",
      "Product": {
        "Id": 123,
        "Price": 123.0,
        "PaymentInterval": {
          "Description": "ABC",
          "IntervalType": 0,
          "IntervalsPerPayment": 123
        },
        "Benefits": [
          {
            "Type": 0,
            "SubsidyLimit": 123.0,
            "IsUnlimited": false,
            "Quota": 123,
            "QuotaRemaining": 123
          },
          {
            "Type": 0,
            "SubsidyLimit": 123.0,
            "IsUnlimited": false,
            "Quota": 123,
            "QuotaRemaining": 123
          }
        ]
      }
    }
  },
  "TaxLiabilities": [
    {
      "Type": 1,
      "Country": "ABC",
      "Name": "ABC",
      "FlatRate": 123.0,
      "Description": "ABC",
      "IsSellRestrictionsEffective": false,
      "IsTaxEffective": false
    },
    {
      "Type": 1,
      "Country": "ABC",
      "Name": "ABC",
      "FlatRate": 123.0,
      "Description": "ABC",
      "IsSellRestrictionsEffective": false,
      "IsTaxEffective": false
    }
  ],
  "Location": {
    "Latitude": 123.0,
    "Longitude": 123.0
  },
  "PayNowStatus": 0,
  "SegmentUserId": "ABC",
  "IsBasic": false
}