Returns a user's bidding 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 |
| ItemStatus | integer | 0 - All 1 - Winning 2 - Not Winning |
Status of the won items. Default = 0 - All |
| Keywords | string | Keywords for search | The keywords to use for search |
| SellerName | string | string | Username or Email address of the seller you want to filter by. |
| Sort | integer | 0 - EndingDate 1 - Thumbnail 2 - Title 3 - MyMaxBid 4 - CurrentBid 5 - ItemID |
The field to sort on. Default = 0 - EndingDate |
| SortOrder | integer | 0 - Ascending 1 - Descending |
Sort direction. Default = 0 - Ascending |
| TimeFrame | integer | 0 - ViewCurrent 3 - ViewGoingGoingGone 4 - ViewNewCalendarToday 5 - ViewEndingCalendarToday 6 - ViewNewLast24 7 - ViewNewLast48 15 - ViewNewSinceLastVisit 16 - ViewEndingNext24 |
This sets the time frame to search for. Default = 0 - ViewCurrent. |
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 |
|---|---|---|---|
| CurrentBid | decimal | positive # | The current bid amount on the item. |
| CanOffer | boolean | true/false | Does the Item accept Offers? |
| HasBuyNow | boolean | true or false | Indicates whether or not a "Buy Now" price was specified |
| BuyNowPrice | decimal | positive # | The "Buy Now" price for an item, if applicable. Will be 0 if a "Buy Now" price is not set |
| EndingDateTime | datetime | A valid datetime | The ending date for the item in UTC. |
| 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 # | ItemID of the item. |
| IsWinningBidder | boolean | true/false | Is the current user the high bidder on the item, and if the item has a reserve price, does that user's bid exceed the reserve price? |
| MyMaxBid | decimal | positive # | The max bid for the current user and item. |
| Seller | User Summary | User Summary | The User Summary for 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 | non null string | The Item Title. |
| 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. |
| Rel | Description | Condition |
|---|---|---|
| self | The item details | |
| feedback | View the Seller's feedback summary | |
| selleritems | Seller's other items for sale |