Website logo

Retrieve your weekly sales statistics (new)

Retrieve sales statistics for the authenticated user.

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

<WeeklySummaryCollection>

Statistics for the current week and the previous six weeks.

List Collection of <WeeklySalesItem> or null

A list of weekly sales data for the past 6 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.
WeekToDate <WeeklySalesItem> or null

The week to date totals.
(This type has already been defined)
SixWeekTotals <WeeklySalesItem> or null

The sum of the previous 6 weeks (excludes week to date).
(This type has already been defined)
HvlData <HvlSummary> or null

Summary of data describing how close the member is to paying High Volume Listing Fees.
ContributingListings Integer

How many listings currently count towards the member's HVL-fee-free listing allowance
UserThreshold Integer

How many listings the member can list before incurring HVL fees

Example XML Response (switch to JSON) 

<WeeklySummaryCollection xmlns="http://api.trademe.co.nz/v1">
  <List>
    <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>
  </List>
  <WeekToDate />
  <SixWeekTotals />
  <HvlData>
    <ContributingListings>123</ContributingListings>
    <UserThreshold>123</UserThreshold>
  </HvlData>
</WeeklySummaryCollection>

Example JSON Response (switch to XML) 

{
  "List": [
    {
      "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
    }
  ],
  "WeekToDate": {
  },
  "SixWeekTotals": {
  },
  "HvlData": {
    "ContributingListings": 123,
    "UserThreshold": 123
  }
}