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.
|
||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
file_format | Enumeration (required) | The format of the response. | ||||||||||||
|
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. |
||||||||||||||
|
||||||||||||||||
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 |
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 <UnsoldItem> or null |
A list of the results in the current page. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|