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 SalesCount
SalesValue Number SalesValue
SellThroughRate Number SellThroughRate
FeedbackRating Number FeedbackRating
InTrade Boolean InTrade
IsTopSeller Boolean IsTopSeller
TopSellerStartDate DateTime TopSellerStartDate
QualifyingSalesCount Integer QualifyingSalesCount
QualifyingSalesValue Number QualifyingSalesValue
QualifyingSellThroughRate Number QualifyingSellThroughRate
QualifyingFeedbackRating Number QualifyingFeedbackRating
TopSellerExpiryDate DateTime TopSellerExpiryDate
TopSellerFeeDiscount Number TopSellerFeeDiscount
TopSellerSavings Collection of <TopSellerSaving> or null TopSellerSavings
PeriodStart DateTime PeriodStart
PeriodEnd DateTime PeriodEnd
SavingType String or null SavingType
SavingAmount Number SavingAmount
WeekOffset Integer WeekOffset

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
    }
  ]
}