/ItemsEnded GET

Returns a user's ended items as a List Response.

URL

/ItemsEnded

Verb

GET

Headers

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.

Input

NOTE: Variables to place in the query string of the request.

Parameter	Data Type	Valid Values	Description
BuyerUserID	integer	positive #	The UserID of the buyer for the item, if sold
BuyerUserName	string	string	The User Name of the buyer for the item, if sold
CategoryID	integer	positive #	The CategoryID of the item
HiddenStatus	integer	0 - All 1 - Not Hidden 2 - Hidden	Hidden status of the ended item. Default = 0 - All
ItemID	integer	positive #	The ItemID of the item
ItemStatus	integer	0 - All 1 - Sold 2 - Unsold	Status of the ended item. Default = 0 - All
Keywords	string	Any string	A keyphrase to search for in the item's title, subtitle, or characteristics
RelistStatus	integer	0 - All 1 - Not Relisted 2 - Relisted	Relist status of the ended item. Default = 0 - All
SerialNumber	string	string	The serial number of the item
SKU	string	string	The SKU of the item
Sort	integer	0 - BidCount (Unsold) 1 - Buy Now Price (Unsold) 2 - Buyer Name (Sold) 3 - End Date (Both) 4 - Expiration Date (Both) 5 - Feedback Status (sorts by BuyerPostedFeedback then by SellerPostedFeedback - Sold) 6 - Fixed Price (Unsold) 7 - GSIN (Both) 8 - GTIN (Both) 9 - Current Bid (Unsold) 10 - Item ID (Both) 11 - Quantity (Both) 12 - Relisted (Both) 13 - ReservePrice (Unsold) 14 - Sale Date (Sold) 15 - Sale Price (Sold) 16 - Serial Number (Both) 17 - SKU (Both) 18 - Start Date (Unsold) 19 - Starting Bid (Unsold) 20 - Starting Price (Unsold) 21 - Item Title (Both) 22 - Total Price (Sold) 23 - UPC (Both) 24 - Watchers Count (Unsold)	The field to sort on. Default = 3 - End Date. If an improper sort is selected (e.g. Sale Date for Unsold items), unexpected sort results may occur.
SortOrder	integer	0 - Ascending 1 - Descending	Sort direction. Default = 1 - Descending
TimeFrame	integer	8 - ViewEndedLast24 9 - ViewEndedLast48 10 - ViewEndedLastWeek 11 - ViewEndedLast2Weeks 12 - ViewEndedLast30Days 13 - ViewEndedLast60Days 14 - ViewEndedLast90Days 18 - ViewExpiredLast90Days	Using this parameter requires a valid X-AccessToken authentication header. This sets the time frame to search for. Default = 12 - ViewEndedLast30Days

Optional PagingParameters

Output

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
BidCount	integer	positive #	Number of bids on the item
Buyer	User Summary	User Summary	The Buyer of the item, if sold
BuyerPostedFeedback	boolean	true/false	Indicates if the buyer has posted feedback for the sold item
BuyNowPrice	decimal	positive #	The "Buy Now" price for an item, if applicable. Will be 0 if a "Buy Now" price is not set
CategoryID	integer	positive #	The CategoryID belonging to the item
CurrentBid	decimal	positive #	The current bid amount for the item
EndDate	datetime	Valid ISO 8601 DateTime format	Date the auction ended in UTC
ExpirationDate	datetime	Valid ISO 8601 DateTime format	The expiration date and time of the listing in UTC
FixedPrice	decimal	positive #	The fixed price value of the item
GSIN	string	string	The GSIN on the item
GTIN	string	string	The GTIN on the item
HasColor	boolean	true/false	Whether or not this item has the paid Colored Title feature
IsHiddenItem	boolean	true/false	Whether or not this item has been hidden in the Ended Items view
IsSoldItem	boolean	true/false	Whether or not this item has been sold
IsTitleBoldface	boolean	true/false	Whether or not this item's title is bold
ItemID	integer	positive #	ID of the ended item
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 0 - No Order (item did not sell) 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 in UTC, if applicable
SalePrice	decimal	positive #	The amount the item sold for, if applicable
Seller	User Summary	User Summary	The Seller of the item
SellerPostedFeedback	boolean	true/false	Indicates if the seller has posted feedback for the sold item
SerialNumber	string	string	The serial number of the item
SKU	string	string	The SKU of the item
StartDate	datetime	Valid ISO 8601 DateTime format	Date the auction started in UTC
StartingBid	decimal	positive #	The amount the bidding started at for auctions
StartingPrice	decimal	positive #	The amount the item started selling at
SubTitle	string	string	The subtitle of an item
Title	string	string	Title of the item sold
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, if sold, including cost for multiple quantities, shipping, and sales tax
UPC	string	string	The item's UPC
WatchersCount	integer	positive #	Number of users watching the item

Links

Rel	Description	Condition
self	The item details