Website logo

Retrieve your lost items

Retrieves listings the authenticated user lost. A listing counts as "lost" if it is on the user's watchlist when it closes.

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

filter String (required)

A filter on the results.

AllReturn all lost items.
Last7DaysReturns items lost in the last 7 days.
Last24HoursReturns items lost in the last 24 hours.

file_format Enumeration (required) The format of the response.
xml Serialize responses into XML.
json Serialize responses into JSON.

Query String parameters

exclude_fpo Boolean (optional)

If true, excludes listings with active fixed price offers.

page Integer (optional)

The page number of the set of results to return, starting from 1. Defaults to 1.

photo_size Enumeration (optional)

The size of the images to return in the results. Defaults to Thumbnail.

Thumbnail

The thumbnail sized photo (always 85x64, with white borders).

List

The list view sized photo (scaled down to fit 160x120).

Medium

The medium sized photo (scaled down to fit 175x175).

Gallery

The gallery sized photo (scaled down to fit 233x176).

Large

The large sized photo (scaled down to fit 352x264).

FullSize

The full sized photo (scaled down to fit 670x502).

rows Integer (optional)

The number of results per page; also the maximum number of results to return. Defaults to 50.

Returns

<Listings>

FullListedItemCollection for the authenticated user.

TotalCount Integer

The total number of results in the collection. Can be larger than the number of returned results.

Page Integer

The index of the current page of results (starts at 1).

PageSize Integer

The number of results in the current page.

List Collection of <Listing> or null

A list of the results in the current page.

ListingId Long Integer

The ID of the listing.

Title String or null

The listing title.

Category String or null

The listing category.

StartPrice Number

The start price.

BuyNowPrice Number

The Buy Now price.

StartDate DateTime

The date the listing was created.

EndDate DateTime

The date the listing will end.

MaxBidAmount Number

The current leading bid amount.

AsAt DateTime

The date and time the response was generated on the server.

CategoryPath String or null

The category path.

PictureHref String or null

The URL of the primary photo for the listing (if the listing has a photo). By default you'll get a thumbnail-sized photo, but you can control the size of the photo using the photo_size parameter.

PhotoId Integer

The ID of the primary photo for the listing (if the listing has a photo).

HasPayNow Boolean

Indicates whether the item has Pay Now.

IsNew Boolean

Indicates whether the item is marked as new.

BidCount Integer

The number of bids on the item.

IsReserveMet Boolean

Indicates whether the item's reserve has been met.

HasReserve Boolean

Indicates whether the item has a reserve.

HasBuyNow Boolean

Indicates whether the item has Buy Now.

Note String or null

The note on an item.

NoteId Integer

The note id on an item.

NoteDate DateTime

The date of the note on an item.

CategoryName String or null

The display name of the category.

ReserveState Enumeration

The flag to display on an item.

None 0

There is no reserve on the item (i.e. the reserve price is the same as the starting price).

Met 1

The value of the highest bid has exceeded the reserve price.

NotMet 2

The value of the highest bid has not reached the reserve price.

NotApplicable 3

The listing cannot have a reserve because bidding is not allowed. This may be because it is a classified or because it is a Buy Now Only auction.

IsClassified Boolean

Indicates whether the item is a classified.

RelistedItemId Long Integer

The ID of the new listing if this listing was relisted.

Subtitle String or null

The subtitle, if present.

IsBuyNowOnly Boolean

Indicates whether or not this is a Buy Now Only listing.

RemainingGalleryPlusRelists Integer or null

The number of times the item can be relisted and get the gallery promotion for free. This value is only present if you are the seller and the listing had the gallery promotion applied due to the gallery plus promotion. Note that for this field, a value of zero is not the same as if the field is missing (a value of zero means gallery plus is in effect whereas if the field is missing it means that you are not the seller or gallery plus is not in effect).

PriceDisplay String or null

The price, in a format suitable for displaying to the user. Some categories may have special pricing rules, e.g. properties may have "Price by negotiation".

CanRequestRelist Boolean

Indicates whether the member can request that the seller relist the item.

CanRequestOffer Boolean

Indicates whether the member can request that the seller create a fixed price offer for the item.

IsClearance Boolean

This indicates that the listing is a clearance item. Clearance listings include listings with was/now pricing and general clearance stock.

WasPrice Number or null

The usual price that a product is sold at, or the price before it was marked down. This is always more than the Buy Now price for Auctions, or more than the asking price for Classifieds.This field will only be populated if IsClearance is true.

PercentageOff Integer or null

The percentage that a product has been discounted. This has been rounded for display purposes. This field will only be populated if IsClearance is true.

Options Collection of <Option> or null

The combination of variant options that this variant represents.

(This type has already been defined)
ListingGroupId Long Integer or null

The identifier of the group of related multi-variant listings. Blank if the listing is not multi-variant

Example XML Response (switch to JSON)

<Listings xmlns="http://api.trademe.co.nz/v1">
  <TotalCount>123</TotalCount>
  <Page>123</Page>
  <PageSize>123</PageSize>
  <List>
    <Listing>
      <ListingId>123</ListingId>
      <Title>ABC</Title>
      <Category>ABC</Category>
      <StartPrice>123.0</StartPrice>
      <BuyNowPrice>123.0</BuyNowPrice>
      <StartDate>2018-01-01T00:00:00Z</StartDate>
      <EndDate>2018-01-01T00:00:00Z</EndDate>
      <MaxBidAmount>123.0</MaxBidAmount>
      <AsAt>2018-01-01T00:00:00Z</AsAt>
      <CategoryPath>ABC</CategoryPath>
      <PictureHref>ABC</PictureHref>
      <PhotoId>123</PhotoId>
      <HasPayNow>false</HasPayNow>
      <IsNew>false</IsNew>
      <BidCount>123</BidCount>
      <IsReserveMet>false</IsReserveMet>
      <HasReserve>false</HasReserve>
      <HasBuyNow>false</HasBuyNow>
      <Note>ABC</Note>
      <NoteId>123</NoteId>
      <NoteDate>2018-01-01T00:00:00Z</NoteDate>
      <CategoryName>ABC</CategoryName>
      <ReserveState>None</ReserveState>
      <IsClassified>false</IsClassified>
      <RelistedItemId>123</RelistedItemId>
      <Subtitle>ABC</Subtitle>
      <IsBuyNowOnly>false</IsBuyNowOnly>
      <RemainingGalleryPlusRelists>123</RemainingGalleryPlusRelists>
      <PriceDisplay>ABC</PriceDisplay>
      <CanRequestRelist>false</CanRequestRelist>
      <CanRequestOffer>false</CanRequestOffer>
      <IsClearance>false</IsClearance>
      <WasPrice>123.0</WasPrice>
      <PercentageOff>123</PercentageOff>
      <Options>
        <Option />
        <Option />
      </Options>
      <ListingGroupId>123</ListingGroupId>
    </Listing>
    <Listing>
      <ListingId>123</ListingId>
      <Title>ABC</Title>
      <Category>ABC</Category>
      <StartPrice>123.0</StartPrice>
      <BuyNowPrice>123.0</BuyNowPrice>
      <StartDate>2018-01-01T00:00:00Z</StartDate>
      <EndDate>2018-01-01T00:00:00Z</EndDate>
      <MaxBidAmount>123.0</MaxBidAmount>
      <AsAt>2018-01-01T00:00:00Z</AsAt>
      <CategoryPath>ABC</CategoryPath>
      <PictureHref>ABC</PictureHref>
      <PhotoId>123</PhotoId>
      <HasPayNow>false</HasPayNow>
      <IsNew>false</IsNew>
      <BidCount>123</BidCount>
      <IsReserveMet>false</IsReserveMet>
      <HasReserve>false</HasReserve>
      <HasBuyNow>false</HasBuyNow>
      <Note>ABC</Note>
      <NoteId>123</NoteId>
      <NoteDate>2018-01-01T00:00:00Z</NoteDate>
      <CategoryName>ABC</CategoryName>
      <ReserveState>None</ReserveState>
      <IsClassified>false</IsClassified>
      <RelistedItemId>123</RelistedItemId>
      <Subtitle>ABC</Subtitle>
      <IsBuyNowOnly>false</IsBuyNowOnly>
      <RemainingGalleryPlusRelists>123</RemainingGalleryPlusRelists>
      <PriceDisplay>ABC</PriceDisplay>
      <CanRequestRelist>false</CanRequestRelist>
      <CanRequestOffer>false</CanRequestOffer>
      <IsClearance>false</IsClearance>
      <WasPrice>123.0</WasPrice>
      <PercentageOff>123</PercentageOff>
      <Options>
        <Option />
        <Option />
      </Options>
      <ListingGroupId>123</ListingGroupId>
    </Listing>
  </List>
</Listings>

Example JSON Response (switch to XML)

{
  "TotalCount": 123,
  "Page": 123,
  "PageSize": 123,
  "List": [
    {
      "ListingId": 123,
      "Title": "ABC",
      "Category": "ABC",
      "StartPrice": 123.0,
      "BuyNowPrice": 123.0,
      "StartDate": "\/Date(1514764800)\/",
      "EndDate": "\/Date(1514764800)\/",
      "MaxBidAmount": 123.0,
      "AsAt": "\/Date(1514764800)\/",
      "CategoryPath": "ABC",
      "PictureHref": "ABC",
      "PhotoId": 123,
      "HasPayNow": false,
      "IsNew": false,
      "BidCount": 123,
      "IsReserveMet": false,
      "HasReserve": false,
      "HasBuyNow": false,
      "Note": "ABC",
      "NoteId": 123,
      "NoteDate": "\/Date(1514764800)\/",
      "CategoryName": "ABC",
      "ReserveState": 0,
      "IsClassified": false,
      "RelistedItemId": 123,
      "Subtitle": "ABC",
      "IsBuyNowOnly": false,
      "RemainingGalleryPlusRelists": 123,
      "PriceDisplay": "ABC",
      "CanRequestRelist": false,
      "CanRequestOffer": false,
      "IsClearance": false,
      "WasPrice": 123.0,
      "PercentageOff": 123,
      "Options": [
        {
        },
        {
        }
      ],
      "ListingGroupId": 123
    },
    {
      "ListingId": 123,
      "Title": "ABC",
      "Category": "ABC",
      "StartPrice": 123.0,
      "BuyNowPrice": 123.0,
      "StartDate": "\/Date(1514764800)\/",
      "EndDate": "\/Date(1514764800)\/",
      "MaxBidAmount": 123.0,
      "AsAt": "\/Date(1514764800)\/",
      "CategoryPath": "ABC",
      "PictureHref": "ABC",
      "PhotoId": 123,
      "HasPayNow": false,
      "IsNew": false,
      "BidCount": 123,
      "IsReserveMet": false,
      "HasReserve": false,
      "HasBuyNow": false,
      "Note": "ABC",
      "NoteId": 123,
      "NoteDate": "\/Date(1514764800)\/",
      "CategoryName": "ABC",
      "ReserveState": 0,
      "IsClassified": false,
      "RelistedItemId": 123,
      "Subtitle": "ABC",
      "IsBuyNowOnly": false,
      "RemainingGalleryPlusRelists": 123,
      "PriceDisplay": "ABC",
      "CanRequestRelist": false,
      "CanRequestOffer": false,
      "IsClearance": false,
      "WasPrice": 123.0,
      "PercentageOff": 123,
      "Options": [
        {
        },
        {
        }
      ],
      "ListingGroupId": 123
    }
  ]
}