Website logo

Retrieve your Top Seller status summary

Retrieve information for the authenticated user on if they have, or are eligible for Top Seller status.

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

<TopSellerSummary>

Statistics for the current week and the previous six weeks.

SalesCount Integer

The number of sales over the last six weeks.
SalesValue Number

The total value of sales in dollars over the last six weeks.
SellThroughRate Number

The sell-through rate in percentage over the last six weeks.
FeedbackRating Number

The feedback rating over the last six weeks.
InTrade Boolean

Whether this member is in trade or not
IsTopSeller Boolean

Whether or not the member is a Top Seller.
TopSellerStartDate DateTime

The start date of the current period in which the member is a top seller (in UTC). Only applicable to members that are top sellers.
QualifyingSalesCount Integer

The number of sales threshold the seller has to reach to eligible for Top Seller status
QualifyingSalesValue Number

The value of sales threshold the seller has to reach to eligible for Top Seller status
QualifyingSellThroughRate Number

The sell-through rate threshold the seller has to reach to eligible for Top Seller status
QualifyingFeedbackRating Number

The positive feedback ratio threshold the seller has to reach to eligible for Top Seller status
TopSellerExpiryDate DateTime

The end date of the current period in which the member is a top seller (in UTC). Only applicable to members that are top sellers.
TopSellerFeeDiscount Number

The percentage of discount (e.g. 0.15 for 15%) applicable to all fees except withdrawal fees, gallery plus, subtitle, reserve, 10-day auction, scheduled end time and second category. Only applicable to members that are top sellers.
TopSellerSavings Collection of <TopSellerSaving> or null

The Top Seller savings for this member.
PeriodStart DateTime

The start date of the period (in UTC).
PeriodEnd DateTime

The end date of the period (in UTC).
SavingType String or null

The fee type.
SavingAmount Number

The amount saved.
WeekOffset Integer

How many weeks before the current week this saving is. 0 = current week.

Example XML Response (switch to JSON) 

<TopSellerSummary xmlns="http://api.trademe.co.nz/v1">
  <SalesCount>123</SalesCount>
  <SalesValue>123.0</SalesValue>
  <SellThroughRate>123.0</SellThroughRate>
  <FeedbackRating>123.0</FeedbackRating>
  <InTrade>false</InTrade>
  <IsTopSeller>false</IsTopSeller>
  <TopSellerStartDate>2018-01-01T00:00:00Z</TopSellerStartDate>
  <QualifyingSalesCount>123</QualifyingSalesCount>
  <QualifyingSalesValue>123.0</QualifyingSalesValue>
  <QualifyingSellThroughRate>123.0</QualifyingSellThroughRate>
  <QualifyingFeedbackRating>123.0</QualifyingFeedbackRating>
  <TopSellerExpiryDate>2018-01-01T00:00:00Z</TopSellerExpiryDate>
  <TopSellerFeeDiscount>123.0</TopSellerFeeDiscount>
  <TopSellerSavings>
    <TopSellerSaving>
      <PeriodStart>2018-01-01T00:00:00Z</PeriodStart>
      <PeriodEnd>2018-01-01T00:00:00Z</PeriodEnd>
      <SavingType>ABC</SavingType>
      <SavingAmount>123.0</SavingAmount>
      <WeekOffset>123</WeekOffset>
    </TopSellerSaving>
    <TopSellerSaving>
      <PeriodStart>2018-01-01T00:00:00Z</PeriodStart>
      <PeriodEnd>2018-01-01T00:00:00Z</PeriodEnd>
      <SavingType>ABC</SavingType>
      <SavingAmount>123.0</SavingAmount>
      <WeekOffset>123</WeekOffset>
    </TopSellerSaving>
  </TopSellerSavings>
</TopSellerSummary>

Example JSON Response (switch to XML) 

{
  "SalesCount": 123,
  "SalesValue": 123.0,
  "SellThroughRate": 123.0,
  "FeedbackRating": 123.0,
  "InTrade": false,
  "IsTopSeller": false,
  "TopSellerStartDate": "\/Date(1514764800)\/",
  "QualifyingSalesCount": 123,
  "QualifyingSalesValue": 123.0,
  "QualifyingSellThroughRate": 123.0,
  "QualifyingFeedbackRating": 123.0,
  "TopSellerExpiryDate": "\/Date(1514764800)\/",
  "TopSellerFeeDiscount": 123.0,
  "TopSellerSavings": [
    {
      "PeriodStart": "\/Date(1514764800)\/",
      "PeriodEnd": "\/Date(1514764800)\/",
      "SavingType": "ABC",
      "SavingAmount": 123.0,
      "WeekOffset": 123
    },
    {
      "PeriodStart": "\/Date(1514764800)\/",
      "PeriodEnd": "\/Date(1514764800)\/",
      "SavingType": "ABC",
      "SavingAmount": 123.0,
      "WeekOffset": 123
    }
  ]
}