Returns 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 |
---|---|---|---|
TimeFrame | integer |
8 - ViewEndedLast24 9 - ViewEndedLast48 10 - ViewEndedLastWeek 11 - ViewEndedLast2Weeks |
Using this parameter requires a valid X-AccessToken authentication header. This sets the time frame to search for. Default = 8 - ViewEndedLast24. |
CategoryID | integer | positive # | The CategoryID of the sold item |
GTIN | string | string | The GTIN of the sold item |
UPC | string | string | The UPC of the item |
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 |
---|---|---|---|
CategoryID | integer | positive # | The CategoryID of the item sold |
GTIN | string | string | The GTIN of the item sold |
ItemID | integer | positive # | ID of the item sold |
ItemTitle | string | string | Title of the item sold. |
Quantity | integer | positive # | The quantity purchased |
SaleDate | datetime | Valid ISO 8601 DateTime format | Date the item was purchased |
SalePrice | decimal | positive # | The amount the item sold for |
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 |
UPC | string | string | The UPC of the item sold |
Rel | Description | Condition |
---|---|---|
self | The item details |