GunBroker.com REST API
DevKey (optional)     
Enter your DevKey for more detailed help!

/OrdersSold GET

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

URL
/OrdersSold
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 # User ID of the Buyer on the Order
BuyerUserName string string UserName of the Buyer on the Order
FFLStatus integer 0 - All

1 - Awaiting FFL

2 - FFL Received

3 - FFL Not Required
 Filter by FFL status on the Order. Default = 0 - All.
IsLayaway boolean true/false This is an optional filter that, when specified, will include (true) or exclude (false) Orders where the Buyer selected Layaway. If not specified, the filter will not be applied.
ItemID integer positive # ItemID of the item on the Order
Keywords string string Search for Orders containing the provided keywords
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

10 - On Layaway

11 - Payment In Process

12 - Returned

13 - Refunded 		Status of the sold order. Default = 0 - All
OrderStatusExclude list of integers Valid Order Status values (see OrderStatus) Comma separated list of Order Statuses to exclude from the search results.
OrderStatusInclude list of integers Valid Order Status values (see OrderStatus) Comma separated list of Order Statuses to include in the search results.
Sort integer Sorts are determined by status date.

0 - Order ID

1 - Buyer 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 Complete

11 - On Layaway

12 - Payment In Process 		The field to sort on. Default = 0 - OrderID
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

8 - All 		Using this parameter requires a valid X-AccessToken authentication header. This sets the time frame to search for. Default = 3 - CreatedLastWeek.
IsChargeback boolean true/false Indicates if the Order has a Chargeback recorded against it.

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
Buyer User Summary User Summary The Buyer of the item on the order
BuyerConfirmed boolean true/false Indicates if Buyer has Confirmed the order
BuyerReviewed boolean true/false Indicates if Buyer has reviewed the order
CanMarkPaymentNotReceived boolean true/false Indicates if the Seller change the payment status to unpaid
CouponCode string string Coupon Code used in this order
CouponValue Decimal Decimal Value of the Coupon applied to this order
eFFLUrl string string The URL for the eFFL document associated to the selected FFL
FFLID integer integer The Object ID for the selected FFL
FFLReceived boolean true/false Indicates if Seller has Received FFL information
ItemIDs array[integers] array of positive # An array of itemIDs on the order
CanRelist boolean true/false Indicates if the Item associated to the Order can be relisted. This would be false if the Item has been purged.
RelistPrice decimal positive # The price to relist the item
ItemShipped boolean true/false Indicates if the item has been shipped
LastModifiedDate DateTime Valid ISO 8601 DateTime format The time is returned in UTC.
LostCashDiscount decimal decimal Discount amount lost when using a credit card.
LostCashDiscountPercent decimal decimal Percentage Discount lost when using a credit card.
MiscCharge decimal decimal Miscellaneous charge on the Order
MiscFee decimal decimal Miscellaneous State Fee on the Order
MiscFeeDescription string string Description for Miscellaneous State Fee on the Order
MiscFeeInfoBug string html Tooltip html for Miscellaneous State Fee on the Order
OnLayaway boolean true/false Indicates if the order is currently on Layaway
OrderCancelled boolean true/false Indicates if the order is canceled
OrderComplete boolean true/false Indicates if the order is complete
OrderRefunded boolean true/false Indicates if the order is refunded
OrderReturned boolean true/false Indicates if the order is returned
OrderDateUTC DateTime Valid ISO 8601 DateTime format The time is returned in UTC.
PaymentInProcess boolean true/false Indicates if the order has a payment still in process
SellerReviewCompleteDateUTC DateTime Valid ISO 8601 DateTime format The time is returned in UTC.
BuyerConfirmationDateUTC DateTime Valid ISO 8601 DateTime format The time is returned in UTC.
PaymentInProcessDateUTC DateTime Valid ISO 8601 DateTime format The time is returned in UTC.
PaymentReceivedDateUTC DateTime Valid ISO 8601 DateTime format The time is returned in UTC.
PaymentReminderDateUTC DateTime Valid ISO 8601 DateTime format The is the time a payment reminder was most recently send in UTC.
CreditRequestInitiatedUTC DateTime Valid ISO 8601 DateTime format The is the time a credit request was initiated in UTC.
FFLReceivedDateUTC DateTime Valid ISO 8601 DateTime format The time is returned in UTC.
ShipDateUTC DateTime Valid ISO 8601 DateTime format The time is returned in UTC.
SellerForcedCompleteDateUTC DateTime Valid ISO 8601 DateTime format The time is returned in UTC.
LayawayAcceptanceDateUTC DateTime Valid ISO 8601 DateTime format The time is returned in UTC.
ReturnedDateUTC DateTime Valid ISO 8601 DateTime format The time is returned in UTC.
RefundDateUTC DateTime Valid ISO 8601 DateTime format The time is returned in UTC.
ChargebackDateUTC DateTime Valid ISO 8601 DateTime format The is the date time (in UTC) a Chargeback was placed on the Order.
IsChargeback boolean true/false Indicates if the Order has a Chargeback recorded against it.
BuyerReviewedDateUTC DateTime Valid ISO 8601 DateTime format The time is returned in UTC.
CancelDateUTC DateTime Valid ISO 8601 DateTime format The time is returned in UTC.
FFLNumber string string The FFL number belonging to the order. ( if the order needed a FFL )
PaymentMethods key/pair ( integer/string ) 2 - Certified Funds
4 - Personal Check
8 - Visa MasterCard
16 - COD
32 - GunTab Escrow
64 - AMEX
128 - Discover
512 - PayPal
8192 - Certified Check
16384 - USPS Money Order
32768 - Money Order 		The payment methods the buyer selected.
OrderID integer positive # ID of the Order
OrderItemsCollection Order Item Order Item The Order Item information for the items in the order
PartialRefund boolean true/false Indicates if a partial refund has been issued
PartialRefundDateUTC DateTime true/false The date time (UTC) the last partial refund was issued
PaymentLogAmount decimal positive # The amount for the most recent payment log transaction
PaymentLogCleared boolean true/false Indicates if the most recent payment log transaction was cleared
PaymentLogDateTime DateTime Valid ISO 8601 DateTime format The datetime (in UTC) for the most recent payment log transaction
PaymentLogResponseCode string string The response code for the most recent payment log transaction
PaymentLogTransactionID string string The transaction ID for the most recent payment log transaction
PaymentReceived boolean true/false Indicates if Seller has received payment
RefundFailed boolean true/false Indicates if a refund has failed
RefundFailedDateUTC DateTime true/false The date time (UTC) the refund failed
Seller User Summary User Summary The Seller of the item on the order
SellerReviewed boolean true/false Indicates if Seller has reviewed the order
ShipTerms number number Accepted shipping terms
ShipToAddress1 string string Address1 of the buyer
ShipToAddress2 string string Address2 of the buyer
ShipToCity string string City of the buyer
ShipToCountryCode string string Country of the buyer
ShipToName string string Name of the buyer
ShipToPostalCode string string Postal code of the buyer
ShipToState string string State or provinces of the buyer
ShipToPhone string string Phone number of the buyer
ShipToEmail string string Email of the buyer
BillToName string string Billing Name of the buyer
BillToAddress1 string string Billing Address1 of the buyer
BillToAddress2 string string Billing Address2 of the buyer
BillToCity string string Billing City of the buyer
BillToState string string Billing State of the buyer
BillToPostalCode string string Billing PostalCode of the buyer
BillToCountryCode string string Billing Country Code of the buyer
BillToPhone string string Billing Phone Number of the buyer
BillToEmail string string Billing Email of the buyer
ShipClass key/pair ( integer/string ) 0 - None
1 - Overnight
2 - 2-Day
4 - 3-Day
8 - Ground
16 - USPS 1st Class
32 - USPS Priority Mail
64 - Other
128 - In-Store Pickup
256 - Alaska, Hawaii & Terr., Non-Continental US, Other 		What shipping carrier is shipping this order.
ShipCost decimal positive # Shipping Price on the Order
ShipHandlingCost decimal positive # Shipping Handling Price on the Order
ShipInsuranceCost decimal positive # Shipping Insurance Price on the Order
TaxExempt boolean true/false Indicates if the Order is Tax Exempt
TotalPrice decimal positive # Total Price on the Order
ComplianceFee decimal positive # Compliance Fee on the Order
SalesTaxTotal decimal positive # Total Sales Tax and Compliance Fee on the Order
TaxCloudCartID GUID GUID If TaxCloud was used to calculate taxes for this order, you can use this value to lookup the transaction in TaxCloud. This value will be null if Taxes were not calculated via TaxCloud.
BuyersPremium decimal positive # Buyers Premium Fee on the Order
OrderAcknowledgeDateUTC DateTime true/false The date time (UTC) the Order was acknowledged

Links

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