Website logo

Retrieve your weekly sales statistics

Retrieve sales statistics for the authenticated user.

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

Collection of <WeeklySalesItem>

Statistics for the current week and the previous six weeks.

StartDate DateTime

The start date of the summary.

EndDate DateTime

The end date of the summary.

ReserveMet Integer

The number of items which met their reserve price in the time period.

BuyNow Integer

The number of items which were purchased via Buy Now in the time period.

FixedPriceOffer Integer

The number of items which sold via a fixed price offer in the time period.

TotalSold Integer

The number of items sold in the time period.

TotalValue Number

The total value of items sold in the time period.

UnsoldItems Integer

The total number of items unsold in the time period.

SellThroughRate Number

The sell-through rate in the time period.

Example XML Response (switch to JSON)

<WeeklySales xmlns="http://api.trademe.co.nz/v1">
  <WeeklySalesItem>
    <StartDate>2018-01-01T00:00:00Z</StartDate>
    <EndDate>2018-01-01T00:00:00Z</EndDate>
    <ReserveMet>123</ReserveMet>
    <BuyNow>123</BuyNow>
    <FixedPriceOffer>123</FixedPriceOffer>
    <TotalSold>123</TotalSold>
    <TotalValue>123.0</TotalValue>
    <UnsoldItems>123</UnsoldItems>
    <SellThroughRate>123.0</SellThroughRate>
  </WeeklySalesItem>
  <WeeklySalesItem>
    <StartDate>2018-01-01T00:00:00Z</StartDate>
    <EndDate>2018-01-01T00:00:00Z</EndDate>
    <ReserveMet>123</ReserveMet>
    <BuyNow>123</BuyNow>
    <FixedPriceOffer>123</FixedPriceOffer>
    <TotalSold>123</TotalSold>
    <TotalValue>123.0</TotalValue>
    <UnsoldItems>123</UnsoldItems>
    <SellThroughRate>123.0</SellThroughRate>
  </WeeklySalesItem>
</WeeklySales>

Example JSON Response (switch to XML)

[
  {
    "StartDate": "\/Date(1514764800)\/",
    "EndDate": "\/Date(1514764800)\/",
    "ReserveMet": 123,
    "BuyNow": 123,
    "FixedPriceOffer": 123,
    "TotalSold": 123,
    "TotalValue": 123.0,
    "UnsoldItems": 123,
    "SellThroughRate": 123.0
  },
  {
    "StartDate": "\/Date(1514764800)\/",
    "EndDate": "\/Date(1514764800)\/",
    "ReserveMet": 123,
    "BuyNow": 123,
    "FixedPriceOffer": 123,
    "TotalSold": 123,
    "TotalValue": 123.0,
    "UnsoldItems": 123,
    "SellThroughRate": 123.0
  }
]