Returns a user's sold 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 - Awaiting Payment 2 - Awaiting FFL 3 - Awaiting Shipping 4 - Not Relisted 5 - Relisted 6 - Received Payment 7 - Received FFL 8 - Sent Item |
Status of the sold items. Default = 0 - All |
Sort | integer |
0 - Thumbnail
1 - Title 2 - Buyer Name 3 - Qty 4 - SaleDate 5 - SalePrice 6 - TotalPrice 7 - ItemID 8 - Serial Number 9 - SKU 10 - Payment Status (sorts by TotalSentDate then by SellerReceivedTotalDate) 11 - Feedback Status (sorts by BuyerPostedFeedback then by SellerPostedFeedback) 12 - FFL Status (sorts by BuyerSentFFLDate then by SellerReceivedFFLDate) 13 - Shipping Status (sorts by SellerSentItemDate then by BuyerReceivedItemDate) 14 - Relisted 15 - Expiration Date |
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. |
BuyerUserID | integer | positive # | The UserID of the buyer for the item |
BuyerUserName | string | string | The User Name of the buyer for the item |
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 |
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 |
---|---|---|---|
BuyNowPrice | decimal | positive # | The "Buy Now" price for an item, if applicable. Will be 0 if a "Buy Now" price is not set |
CurrentBid | decimal | positive # | The current bid amount for the item |
BidCount | integer | positive # | Number of bids on the item |
Buyer | User Summary | User Summary | The Buyer of the item |
BuyerPostedFeedback | boolean | true/false | Indicates if the buyer has posted feedback |
BuyerReceivedItemDate | datetime | Valid ISO 8601 DateTime format | The date the buyer indicated that the item has been received |
BuyerSentFFLDate | datetime | Valid ISO 8601 DateTime format | The date the buyer indicated that FFL information has been sent |
BuyerSentPaymentDate | datetime | Valid ISO 8601 DateTime format | The date the buyer indicated that payment has been sent |
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. |
IsTitleBoldface | boolean | true/false | Whether or not this item's title is bold. |
ItemID | integer | positive # | ID of the item sold |
OrderID | integer | number >= 0 | Order ID of the order associated with the item (0 if the item did not sell) |
OrderStatus | integer | positive # |
Current status of the order associated with the item 1 - Pending Seller Review 2 - Pending Buyer Confirmation 3 - Pending Payment Received 4 - Pending Shipment 5 - Complete 6 - Canceled 7 - Pending Buyer Review 10 - On Layaway 11 - Payment In Process 12 - Returned |
Quantity | integer | positive # | The quantity purchased |
Relisted | boolean | true/false | Indicates if the item has been relisted |
RelistPrice | decimal | positive # | The price to relist the item |
ReservePrice | decimal | positive # | The reserve price on the item |
SaleDate | datetime | Valid ISO 8601 DateTime format | Date the item was purchased |
SalePrice | decimal | positive # | The amount the item sold for |
Seller | User Summary | User Summary | The Seller of the item |
SellerPostedFeedback | boolean | true/false | Indicates of the seller has posted feedback |
SellerReceivedPaymentDate | datetime | Valid ISO 8601 DateTime format | The date the seller indicated that payment has been received |
SellerReceivedFFLDate | datetime | Valid ISO 8601 DateTime format | The date the seller indicated that FFL information has been received |
SellerSentItemDate | datetime | Valid ISO 8601 DateTime format | The date the seller indicated that the item has been shipped |
SerialNumber | string | string | The serial number of the item |
SKU | string | string | The SKU of the item |
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. |
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 |
TotalPrice | decimal | positive # | Total amount for the item including cost for multiple quantities, shipping, and sales tax |
ExpirationDate | datetime | Valid ISO 8601 DateTime format | The expiration date and time of the listing |
Rel | Description | Condition |
---|---|---|
self | The item details |