/OrdersWon GET

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

URL
/OrdersWon
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 body of the request.

Parameter Data Type Valid Values Description
SellerUserID integer positive # User ID of the Seller on the Order
SellerUserName string string UserName of the Seller on the Order
ItemID integer positive # ItemID of the item on the Order
OrdersModifiedSinceDate string Valid ISO 8601 DateTime format NOTE: Time entered is in UTC format.
OrderStatus integer 0 - All

1 - Pending Seller Review

2 - Pending Buyer Confirmation

3 - Pending Payment Received

4 - Pending Shipment

5 - Complete

6 - Cancelled

7 - Pending Buyer Review
Status of the sold order. Default = 0 - All
Sort integer 0 - Order ID

1 - Seller Name

2 - Item ID

3 - Order Date

4 - Total Price

5 - Seller Reviewed

6 - Buyer Confirmed

7 - Payment Received

8 - FFL Received

9 - Item Shipped

10 - Order Completes
The field to sort on. Default = 0 - Order ID
SortOrder integer 0 - Ascending

1 - Descending
Sort direction. Default = 1 - Descending
TimeFrame integer 1 - CreatedLast24

2 - CreatedLast48

3 - CreatedLastWeek

4 - CreatedLast2Weeks

5 - CreatedLast30Days

6 - CreatedLast60Days

7 - CreatedLast90Days
Using this parameter requires a valid X-AccessToken authentication header. This sets the time frame to search for. Default = 3 - CreatedLastWeek.

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
OrderID integer positive # ID of the Order
ItemIDs array[integers] array of positive # An array of itemIDs on the order
Buyer User Summary User Summary The Buyer of the item on the order
Seller User Summary User Summary The Seller of the item on the order
ShipToName string string Name of the buyer
ShipToAddress1 string string Address1 of the buyer
ShipToAddress2 string string Address2 of the buyer
ShipToCity string string City of the buyer
ShipToState string string State or provinces of the buyer
ShipToPostalCode string string Postal code of the buyer
ShipToCountryCode string string Country of the buyer
BuyerConfirmed boolean true/false Indicates if Buyer has Confirmed the order
BuyerReviewed boolean true/false Indicates if Buyer has reviewed the order
FFLReceived boolean true/false Indicates if Seller has Received FFL information
ItemShipped boolean true/false Indicates if the item has been shipped
LastModifiedDate DateTime Valid ISO 8601 DateTime format The time is returned in UTC.
OrderCancelled boolean true/false Indicates if the order is canelled
OrderComplete boolean true/false Indicates if the order is complete
OrderDateUTC DateTime Valid ISO 8601 DateTime format The time is returned in UTC.
PaymentReceived boolean true/false Indicates if Seller has recieved payment
SellerReviewed boolean true/false Indicates if Seller has reviewed the order
TotalPrice decimal positive # Total Price on the Order
OrderItemsCollection Order Item Order Item The Order Item information for the items in the order

Links

Rel Description Condition
self The order
item The items on the order