Returns a user's won 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 |
---|---|---|---|
CanOffer | boolean | true/false | Returns Items that accept offers if set to true. Returns Items that do not accept offers if set to false |
SellerName | string | string | The username or email of the seller |
Keywords | string | string | Searchable keywords from the item title and description fields |
ItemStatus | integer | 0 - All 1 - Awaiting Payment 2 - Awaiting Feedback |
Status of the won items. Default = 0 - All. The Awaiting Feedback status refers to buyer leaving Feedback (not the sellers) |
Sort | integer | 0 - Thumbnail 1 - Title 2 - Seller Username 3 - Qty 4 - SaleDate 5 - SalePrice 6 - TotalPrice 7 - ItemID |
The field to sort on. Default = 4 - SaleDate |
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 |
Using this parameter requires a valid X-AccessToken authentication header. This sets the time frame to search for. Default = 12 - ViewEndedLast30Days. |
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 |
---|---|---|---|
CanOffer | boolean | true/false | Does the Item accept Offers? |
EndingDate | datetime | Valid ISO 8601 DateTime format | Ending date for the item in UTC |
BidPrice | decimal | positive # | The winning bid amount for the item |
HasColor | boolean | true/false | Whether or not this item has the paid Colored Title feature. |
IsTitleBoldface | boolean | true/false | Whether or not this item's title is bold. |
ItemID | integer | positive # | ID of the item won |
Quantity | integer | positive # | The quantity purchased |
Seller | User Summary | User Summary | The Seller of the item |
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 won |
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. |
TotalPrice | decimal | positive # | Bid Price * Quantity |
DidBuyerLeaveFeedback | boolean | true/false | Whether or not the buyer of the item left feedback |
DidSellerLeaveFeedback | boolean | true/false | Whether or not the seller of the item left feedback |
DidBuyerReceiveItem | boolean | true/false | Whether or not the buyer of the item received the item |
DidSellerSendItem | boolean | true/false | Whether or not the seller of the item sent the item |
DidBuyerSendFFL | boolean | true/false | Whether or not the buyer of the item sent the FFL |
DidSellerReceiveFFL | boolean | true/false | Whether or not the seller of the item received the FFL |
DidBuyerSendPayment | boolean | true/false | Whether or not the buyer of the item sent the payment |
DidSellerReceivePayment | boolean | true/false | Whether or not the seller of the item received the payment |
Rel | Description | Condition |
---|---|---|
self | The item details | |
feedback | View the Seller's feedback summary | |
selleritems | Seller's other items for sale |