Returns a user's scheduled 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 |
ItemID | integer | positive # | The ItemID of the item |
Keywords | string | Any string | A keyphrase to search for in the item's title, subtitle, or characteristics |
SerialNumber | string | string | The Serial Number of the item |
SKU | string | string | The SKU of the item |
Sort | integer |
0 - BuyNowPrice
1 - EndingDate 2 - FixedPrice 3 - ItemID 4 - ItemTitle 5 - Quantity 6 - ReservePrice 7 - Serial Number 8 - SKU 9 - StartingDate 10 - StartingBid 11 - Thumbnail 12 - ExpirationDate 13 - CollectorsElite |
The field to sort on. Default = 9 - StartingDate |
SortOrder | integer |
0 - Ascending 1 - Descending |
Sort direction. Default = 1 - Descending |
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 |
---|---|---|---|
BuyNowPrice | decmial | positive # | The BuyNow price of an item ( if it has one ). |
CanOffer | boolean | true/false | Does the Item accept Offers? |
EndingDate | datetime | Valid ISO 8601 DateTime format | The ending date time of the item in UTC. |
Fixed Priced | decimal | positive # | The fixed price of item. If 0, item is not a fixed price item. You should use the 'IsFixedPrice' property to determine if the item is a fixed price item. |
HasBuyNow | boolean | true/false | Whether or not this item has a Buy Now price |
HasColor | boolean | true/false | Whether or not this item has the paid Colored Title feature. |
HasReserve | boolean | true/false | Whether or not this item has a reserve price |
IsFixedPrice | boolean | true/false | Whether or not this item has a fixed price |
IsTitleBoldface | boolean | true/false | Whether or not this item's title is bold. |
ItemID | integer | positive # | id belonging to item |
Quantity | integer | positive # | The quantity purchased |
ReservePrice | decmial | positive # | The reserve price of an item ( if it has one ). |
SerialNumber | string | string | The item's Serial Number |
SKU | string | string | The SKU of the item. |
StartingBid | decimal | positive # | The starting bid of an item. |
StartingDate | datetime | Valid ISO 8601 DateTime format | The starting date time of the item in UTC. |
SubTitle | string | string | The subtitle of an 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. |
ExpirationDate | datetime | Valid ISO 8601 DateTime format | Expiration Date of the item |
Rel | Description | Condition |
---|---|---|
self | The item details |