Returns a user's unsold items as a List Response.
Header | Data Type | Valid Values | Required | Description |
---|---|---|---|---|
Content-Type | string | application/json | YES | The format your data will be sent to our site. |
X-DevKey | string | string | YES | The devkey assigned to the developer. |
X-AccessToken | string | string | YES | The token acquired from a POST to Users/AccessToken. |
NOTE: Variables to place in the query string of the request.
Parameter | Data Type | Valid Values | Description |
---|---|---|---|
ItemStatus | integer |
0 - All
1 - Not Relisted 2 - Relisted |
Status of the sold items. Default = 0 - All |
Sort | integer |
0 -BidCount,
1 - BuyNowPrice, 3 - EndDate, 4 - FixedPrice, 5 - HighBid, 6 - ItemID, 7 - Title, 8 - Quantity, 9 - Relisted, 10 - ReservePrice, 11 - SerialNumber, 12 - SKU, 13 - StartDate, 14 - StartingBid, 15 - StartingPrice, 17 - UPC, 18 - WatchersCount, 19 - ExpirationDate |
The field to sort on. Default = 3 - EndDate |
SortOrder | integer |
0 - Ascending 1 - Descending |
Sort direction. Default = 1 - Descending |
TimeFrame | integer |
1 - ViewCompleted 8 - ViewEndedLast24 9 - ViewEndedLast48 10 - ViewEndedLastWeek 11 - ViewEndedLast2Weeks 12 - ViewEndedLast30Days 13 - ViewEndedLast60Days 14 - ViewEndedLast90Days 18 - ViewExpiredLast90Days |
Using this parameter requires a valid X-AccessToken authentication header. This sets the time frame to search for. Default = 12 - ViewEndedLast30Days. |
SerialNumber | string | string | The serial number of the item |
SKU | string | string | The SKU of the item |
ItemID | integer | positive # | The ItemID of the item |
CategoryID | integer | positive # | The CategoryID of the item |
Keywords | string | Any string | A keyphrase to search for in the item's title, subtitle, or characteristics |
Optional PagingParameters
If there are no errors with the input parameters, this call will respond with a 200 OK
and the following data as serialized JSON
Parameter | Data Type | Valid Values | Description |
---|---|---|---|
BidCount | integer | positive # | Number of bids on the item |
BuyNowPrice | decimal | positive # | The BuyNow price for the item |
CategoryID | integer | positive # | The CategoryID belonging to the item |
EndDate | datetime | Valid ISO 8601 DateTime format | Date the auction ended |
FixedPrice | decimal | positive # | The fixed price value of the item |
HasColor | boolean | true/false | Whether or not this item has the paid Colored Title feature. |
HighBid | decimal | positive # | The current bid amount for the item |
IsTitleBoldface | boolean | true/false | Whether or not this item's title is bold. |
ItemID | integer | positive # | ID of the item sold |
Quantity | integer | positive # | The quantity purchased |
Relisted | boolean | true/false | Indicates if the item has been relisted |
ReservePrice | decimal | positive # | The reserve price on the item |
SerialNumber | string | string | The serial number of the item |
SKU | string | string | The SKU of the item |
StartDate | datetime | Valid ISO 8601 DateTime format | Date the auction started |
StartingBid | decimal | positive # | The amount the bidding started at for auctions |
StartingPrice | decimal | positive # | The amount the item started selling at |
SubTitle | string | string | The subtitle of an item. |
ThumbnailURL | string | A fully qualified url to an image file | The location of the image file to be used as the thumbnail for the item |
Title | string | string | Title of the item sold. NOTE: The old property ItemTitle is deprecated and will be removed soon. |
TitleColor | string | Valid hex color strings (ex: #000000) | The color of the item title. If the paid feature isn't available, black (#000000) will be returned. |
UPC | string | string | The item's UPC |
WatchersCount | integer | positive # | Number of users watching the item |
ExpirationDate | datetime | Valid ISO 8601 DateTime format | The expiration date and time of the listing |
Rel | Description | Condition |
---|---|---|
self | The item details |