Website logo

Retrieve your unsold items

Retrieves a list of the authenticated user's unsold listings. Multiple-quantity auctions count as unsold if there is a least one item remaining (i.e. Quantity > 0). Listings that are in the closing state are not included in the list.

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

Last45DaysReturns items unsold in the last 45 days.
Last7DaysReturns items unsold in the last 7 days.
Last24HoursReturns items unsold in the last 24 hours.
LastHourReturns items unsold in the last hour.
ItemsIHaveOfferedReturns items with pending offers.
ItemsICanRelistReturns unsold items that can be relisted.
file_format Enumeration (required) The format of the response.
xml Serialize responses into XML.
json Serialize responses into JSON.

Query String parameters

deleted Boolean (optional)

Indicates whether deleted items should be included in the results.
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 Thumbnail
List List
Medium Medium
Gallery Gallery
Large Large
FullSize FullSize
JobSearchCard JobSearchCard
rows Integer (optional)

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

Returns

<UnsoldItems>

A list of unsold items.

TotalCount Integer TotalCount
Page Integer Page
PageSize Integer PageSize
List Collection of <UnsoldItem> or null InnerList
ListingId Integer ListingId
Title String or null Title
Category String or null Category
StartPrice Number StartPrice
BuyNowPrice Number BuyNowPrice
StartDate DateTime StartDate
EndDate DateTime EndDate
ListingLength String or null ListingLength
Restrictions String or null Restrictions
IsFeatured Boolean IsFeatured
HasGallery Boolean HasGallery
IsBold Boolean IsBold
IsHighlighted Boolean IsHighlighted
HasHomePageFeature Boolean HasHomePageFeature
HasExtraPhotos Boolean HasExtraPhotos
HasScheduledEndDate Boolean HasScheduledEndDate
BidderAndWatchers Integer BidderAndWatchers
MaxBidAmount Number MaxBidAmount
AsAt DateTime AsAt
CategoryPath String or null CategoryPath
PictureHref String or null PictureHref
PhotoId Integer PhotoId
BidCount Integer BidCount
ViewCount Integer ViewCount
IsReserveMet Boolean IsReserveMet
HasReserve Boolean HasReserve
HasBuyNow Boolean HasBuyNow
Note String or null Note
NoteId Integer NoteId
NoteDate DateTime NoteDate
CategoryName String or null CategoryName
ReserveState Enumeration ReserveState
None 0 None
Met 1 Met
NotMet 2 NotMet
NotApplicable 3 NotApplicable
Attributes Collection of <Attribute> or null Attributes
Name String or null Name
DisplayName String or null DisplayName
Value String or null Value
IsClassified Boolean IsClassified
RelistedItemId Integer RelistedItemId
Subtitle String or null Subtitle
ReservePrice Number OwnerReservePrice
IsBuyNowOnly Boolean IsBuyNowOnly
Quantity Integer Quantity
RemainingGalleryPlusRelists Integer or null RemainingGalleryPlusRelists
PriceDisplay String or null PriceDisplay
ExternalReferenceId String or null ExternalReferenceId
SKU String or null SKU
IsClearance Boolean IsClearance
WasPrice Number or null WasPrice
PercentageOff Integer or null PercentageOff
Options Collection of <Option> or null Options
(This type has already been defined)
ListingGroupId Integer or null ListingGroupId
OfferIsActive Boolean or null OfferIsActive
IsWithdrawn Boolean IsWithdrawn
QuantityUnsold Integer QuantityUnsold
CanMakeOffer Boolean CanMakeOffer
CanRelist Boolean CanRelist

Example XML Response (switch to JSON) 

<UnsoldItems xmlns="http://api.trademe.co.nz/v1">
  <TotalCount>123</TotalCount>
  <Page>123</Page>
  <PageSize>123</PageSize>
  <List>
    <UnsoldItem>
      <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>
      <ListingLength>ABC</ListingLength>
      <Restrictions>ABC</Restrictions>
      <IsFeatured>false</IsFeatured>
      <HasGallery>false</HasGallery>
      <IsBold>false</IsBold>
      <IsHighlighted>false</IsHighlighted>
      <HasHomePageFeature>false</HasHomePageFeature>
      <HasExtraPhotos>false</HasExtraPhotos>
      <HasScheduledEndDate>false</HasScheduledEndDate>
      <BidderAndWatchers>123</BidderAndWatchers>
      <MaxBidAmount>123.0</MaxBidAmount>
      <AsAt>2018-01-01T00:00:00Z</AsAt>
      <CategoryPath>ABC</CategoryPath>
      <PictureHref>ABC</PictureHref>
      <PhotoId>123</PhotoId>
      <BidCount>123</BidCount>
      <ViewCount>123</ViewCount>
      <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>
      <Attributes>
        <Attribute>
          <Name>ABC</Name>
          <DisplayName>ABC</DisplayName>
          <Value>ABC</Value>
        </Attribute>
        <Attribute>
          <Name>ABC</Name>
          <DisplayName>ABC</DisplayName>
          <Value>ABC</Value>
        </Attribute>
      </Attributes>
      <IsClassified>false</IsClassified>
      <RelistedItemId>123</RelistedItemId>
      <Subtitle>ABC</Subtitle>
      <ReservePrice>123.0</ReservePrice>
      <IsBuyNowOnly>false</IsBuyNowOnly>
      <Quantity>123</Quantity>
      <RemainingGalleryPlusRelists>123</RemainingGalleryPlusRelists>
      <PriceDisplay>ABC</PriceDisplay>
      <ExternalReferenceId>ABC</ExternalReferenceId>
      <SKU>ABC</SKU>
      <IsClearance>false</IsClearance>
      <WasPrice>123.0</WasPrice>
      <PercentageOff>123</PercentageOff>
      <Options>
        <Option />
        <Option />
      </Options>
      <ListingGroupId>123</ListingGroupId>
      <OfferIsActive>false</OfferIsActive>
      <IsWithdrawn>false</IsWithdrawn>
      <QuantityUnsold>123</QuantityUnsold>
      <CanMakeOffer>false</CanMakeOffer>
      <CanRelist>false</CanRelist>
    </UnsoldItem>
    <UnsoldItem>
      <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>
      <ListingLength>ABC</ListingLength>
      <Restrictions>ABC</Restrictions>
      <IsFeatured>false</IsFeatured>
      <HasGallery>false</HasGallery>
      <IsBold>false</IsBold>
      <IsHighlighted>false</IsHighlighted>
      <HasHomePageFeature>false</HasHomePageFeature>
      <HasExtraPhotos>false</HasExtraPhotos>
      <HasScheduledEndDate>false</HasScheduledEndDate>
      <BidderAndWatchers>123</BidderAndWatchers>
      <MaxBidAmount>123.0</MaxBidAmount>
      <AsAt>2018-01-01T00:00:00Z</AsAt>
      <CategoryPath>ABC</CategoryPath>
      <PictureHref>ABC</PictureHref>
      <PhotoId>123</PhotoId>
      <BidCount>123</BidCount>
      <ViewCount>123</ViewCount>
      <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>
      <Attributes>
        <Attribute>
          <Name>ABC</Name>
          <DisplayName>ABC</DisplayName>
          <Value>ABC</Value>
        </Attribute>
        <Attribute>
          <Name>ABC</Name>
          <DisplayName>ABC</DisplayName>
          <Value>ABC</Value>
        </Attribute>
      </Attributes>
      <IsClassified>false</IsClassified>
      <RelistedItemId>123</RelistedItemId>
      <Subtitle>ABC</Subtitle>
      <ReservePrice>123.0</ReservePrice>
      <IsBuyNowOnly>false</IsBuyNowOnly>
      <Quantity>123</Quantity>
      <RemainingGalleryPlusRelists>123</RemainingGalleryPlusRelists>
      <PriceDisplay>ABC</PriceDisplay>
      <ExternalReferenceId>ABC</ExternalReferenceId>
      <SKU>ABC</SKU>
      <IsClearance>false</IsClearance>
      <WasPrice>123.0</WasPrice>
      <PercentageOff>123</PercentageOff>
      <Options>
        <Option />
        <Option />
      </Options>
      <ListingGroupId>123</ListingGroupId>
      <OfferIsActive>false</OfferIsActive>
      <IsWithdrawn>false</IsWithdrawn>
      <QuantityUnsold>123</QuantityUnsold>
      <CanMakeOffer>false</CanMakeOffer>
      <CanRelist>false</CanRelist>
    </UnsoldItem>
  </List>
</UnsoldItems>

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)\/",
      "ListingLength": "ABC",
      "Restrictions": "ABC",
      "IsFeatured": false,
      "HasGallery": false,
      "IsBold": false,
      "IsHighlighted": false,
      "HasHomePageFeature": false,
      "HasExtraPhotos": false,
      "HasScheduledEndDate": false,
      "BidderAndWatchers": 123,
      "MaxBidAmount": 123.0,
      "AsAt": "\/Date(1514764800)\/",
      "CategoryPath": "ABC",
      "PictureHref": "ABC",
      "PhotoId": 123,
      "BidCount": 123,
      "ViewCount": 123,
      "IsReserveMet": false,
      "HasReserve": false,
      "HasBuyNow": false,
      "Note": "ABC",
      "NoteId": 123,
      "NoteDate": "\/Date(1514764800)\/",
      "CategoryName": "ABC",
      "ReserveState": 0,
      "Attributes": [
        {
          "Name": "ABC",
          "DisplayName": "ABC",
          "Value": "ABC"
        },
        {
          "Name": "ABC",
          "DisplayName": "ABC",
          "Value": "ABC"
        }
      ],
      "IsClassified": false,
      "RelistedItemId": 123,
      "Subtitle": "ABC",
      "ReservePrice": 123.0,
      "IsBuyNowOnly": false,
      "Quantity": 123,
      "RemainingGalleryPlusRelists": 123,
      "PriceDisplay": "ABC",
      "ExternalReferenceId": "ABC",
      "SKU": "ABC",
      "IsClearance": false,
      "WasPrice": 123.0,
      "PercentageOff": 123,
      "Options": [
        {
        },
        {
        }
      ],
      "ListingGroupId": 123,
      "OfferIsActive": false,
      "IsWithdrawn": false,
      "QuantityUnsold": 123,
      "CanMakeOffer": false,
      "CanRelist": false
    },
    {
      "ListingId": 123,
      "Title": "ABC",
      "Category": "ABC",
      "StartPrice": 123.0,
      "BuyNowPrice": 123.0,
      "StartDate": "\/Date(1514764800)\/",
      "EndDate": "\/Date(1514764800)\/",
      "ListingLength": "ABC",
      "Restrictions": "ABC",
      "IsFeatured": false,
      "HasGallery": false,
      "IsBold": false,
      "IsHighlighted": false,
      "HasHomePageFeature": false,
      "HasExtraPhotos": false,
      "HasScheduledEndDate": false,
      "BidderAndWatchers": 123,
      "MaxBidAmount": 123.0,
      "AsAt": "\/Date(1514764800)\/",
      "CategoryPath": "ABC",
      "PictureHref": "ABC",
      "PhotoId": 123,
      "BidCount": 123,
      "ViewCount": 123,
      "IsReserveMet": false,
      "HasReserve": false,
      "HasBuyNow": false,
      "Note": "ABC",
      "NoteId": 123,
      "NoteDate": "\/Date(1514764800)\/",
      "CategoryName": "ABC",
      "ReserveState": 0,
      "Attributes": [
        {
          "Name": "ABC",
          "DisplayName": "ABC",
          "Value": "ABC"
        },
        {
          "Name": "ABC",
          "DisplayName": "ABC",
          "Value": "ABC"
        }
      ],
      "IsClassified": false,
      "RelistedItemId": 123,
      "Subtitle": "ABC",
      "ReservePrice": 123.0,
      "IsBuyNowOnly": false,
      "Quantity": 123,
      "RemainingGalleryPlusRelists": 123,
      "PriceDisplay": "ABC",
      "ExternalReferenceId": "ABC",
      "SKU": "ABC",
      "IsClearance": false,
      "WasPrice": 123.0,
      "PercentageOff": 123,
      "Options": [
        {
        },
        {
        }
      ],
      "ListingGroupId": 123,
      "OfferIsActive": false,
      "IsWithdrawn": false,
      "QuantityUnsold": 123,
      "CanMakeOffer": false,
      "CanRelist": false
    }
  ]
}