GunBroker.com REST API
DevKey: darkkermit    

/ItemsCompletedGET

Returns search results as a Item List Response for completed items with given search parameters.

URL
/Items/Completed
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
CanAcceptFreedomCoin boolean true/false If true, only return items that can accept FreedomCoin as a payment method. Note - This only applies to users that can buy with FreedomCoin
Categories string Comma-seperated list of valid category ids Ex: Categories=3024,3026
Condition integer 0 - All Conditions

1 - New Items Only

2 - New and New Old Stock Items

3 - Used and New Old Stock Items

4 - Used Items Only

5 - New Old Stock Items Only

6 - New and Used Items 		The condition an item is in.
Country string 2 character The ISO 2 character country code to search on. EX: Country=US for United States
CanOffer boolean true/false Returns Items that accept offers if set to true. Returns Items that do not accept offers if set to false
DoesNotExcludeState string 2 characters Excludes items that cannot be sold to the 2 digit state or US territory, if provided.
Exclude string string Words or phrases that will be excluded from the search
FeaturedListing boolean true/false Return Featured auctions if set to true. Return auctions without Featured if set to false
FreeShippingAvailable boolean true If set to true, only return items where an available shipping option is free. No effect if set to false.
HasPictures boolean true/false Return auctions with pictures if set to true. Return auctions without pictures if set to false
IncludeAggregateCounts boolean true/false If set to true, aggregate counts are returned in addition to the outputs listed.
IncludeSellers string Comma-seperated seller user ids List of Seller items to search for. Ex: IncludeSellers=1234,5678
Keywords string Keywords for search The keywords to use for search
KeywordOperator integer 0 - All Terms

1 - Any Term

2 - Exact Match 		Whether to search by All Terms, Any Terms or Exact Match
LayawayAvailable boolean true If true, only items that offered Layaway will be returned.
MaxBidCount integer positive # The maximum number of bids an item can have.
MinBidCount integer positive # The minimum number of bids an item can have.
MaxPrice decimal positive # The maximum price an item can have.
MinPrice decimal positive # The minimum price an item can have.
MaxStartingBid decimal positive # The maximum starting bid an item can have.
MinStartingBid decimal positive # The minimum starting bid an item can have.
NoCCFees boolean true If set to true, only return items that accept credit cards with no processing fees. No effect if set to false.
NoReserveItems boolean true/false Return items without a reserve price if set to true. The parameter is ignored if set to false.
SellerName string string Username of the seller you want to look for.
State string 2 character The USPS 2 character state abbreivation.
Sort integer 2 - Item number Asc

3 - Item number Desc

4 - Item price Asc

5 - Item price Desc

6 - Starting date Asc

7 - Starting date Desc

8 - Bid count Asc

9 - Bid count Desc

10 - Quantity Asc

11 - Quantity Desc

12 - Relevance

13 - Featured and then Relevance 		The order in which the results are returned. Default = 13 - Featured and then Relevance
Timeframe integer 1 - View Completed

8 - View Ended Last 24

9 - View Ended Last 48

10 - View Ended Last Week

11 - View Ended Last 2 Weeks

12 - View Ended Last 30 Days
This sets the time frame to search for. Default = 1 - View Completed.
UPC string string UPC you would like to search for.
WillShipInternational boolean true/false Return items that are available to ship out of the country. Return items that are not available to ship out of the country

Optional PagingParameters

Output

If the search parameters are not valid, you will receive a 400 BadRequest and a Message Response indicating the reason.

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
ItemID integer positive # id belonging to item
AuctionPricePerRoundDisplay string currency amount The Ammunition price per round display text based on current or starting bid, if applicable.
Bids integer positive # Number of bids the item has.
BuyNowPrice decimal positive # The "Buy Now" price for an item, if applicable. Will be 0 if a "Buy Now" price is not set
BuyNowPricePerRoundDisplay string currency amount The Ammunition buy now or fixed price price per round display text, if applicable.
CanOffer boolean true/false Does the Item accept Offers?
CreditCardUpChargePercent decimal postive # The percent in decimal form of the credit card up charge. Will be null if not applicable.
EligibleForImmediateCheckout boolean true/false Whether or not this item can be purchased with a credit card immediately.
EndingDate datetime Valid ISO 8601 DateTime format The ending date time of the item in UTC.
FreeShippingAvailable boolean true/false Whether or not the item can potentially have free shipping available
GTIN string string The GTIN on the item.
HasColor boolean true/false Whether or not this item has the paid Colored Title feature.
HasFreedomCoin boolean true/false This item accepts FreedomCoin and User can buy with FreedomCoin. Note - this will only be returned for users that allowed to buy with FreedomCoin.
HasPictures boolean true/false Does the item have pictures?
HasReserve boolean true/false Does the item have reserve price?
HasReserveBeenMet boolean true/false Has the reserved been meet on this item?
HasBuyNow boolean true/false Does the item have a buy now?
HighBidderID integer positive # The user id of the high bidder.
IsCreditCardPaymentMethodAvailable boolean true/false Is there a credit card payment method available on this item?
IsFeaturedItem boolean true/false Is this item featured?
IsFixedPrice boolean true/false Is this item a fixed price item?
IsGatewayEnabled boolean true/false Is there a payment gateway enabled for this item?
IsShowCaseItem boolean true/false Whether or not this item has the paid Showcase Listing feature.
IsHighlighted boolean true/false Whether or not this item has the paid Highlight feature.
IsTitleBoldface boolean true/false Whether or not this item has the paid Boldface Title feature.
LowestShippingCost decimal positive # The lowest fixed priced shipping for an item that is not In-Store Pickup. Null for buyer pays actual.
MfgPartNumber string string The manufacturing part number.
NumberOfRounds integer positive # For ammunition, this is the number of rounds being sold.
PaymentPlan integer 0 - No payment plan

1 - Layaway Available
 Payment plans offered on the item. Multiple payment plans can be offered at the same time and can be determined using bitwise operators.
Price decimal positive # The current cost of an item.
Quantity integer positive # The number of items for sale for this item.
RelistedAsItemID integer positive # The item ID for the item this item was relisted as.
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.
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.
Title string string The title of the item.
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.

Links

Rel Description Condition
self The item details