This returns an item for an ItemID.
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 | Optional | 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 |
---|
If the item id is not valid, you will receive a 404 NotFound
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 |
BidIncrement | decimal | positive # | The bid increment required for the next valid bid. |
Bids | integer | positive # | Number of bids the item has. |
BuyNowPrice | decmial | positive # | The BuyNow price of an item ( if it has one ). |
Buyer | User Summary | User Summary | The Buyer of the item. Null if there was no buyer. |
BuyPrice | decimal | positive # | Purchase Price |
CashDiscount | decimal | positive # | If there is a cash discount to use a credit card, then this value will be a positive number. |
CategoryID | integer | positive # | The category ID associated with the item. |
CategoryName | string | string | The title of the category. |
CollectorsElite | boolean | true/false | Is this a Collectors Elite item? |
CollectsSalesTax | boolean | true/false | Does the User collect sales tax on this item? |
Condition | array key/value pair ( integer/string ) |
1 - New 2 - New Old Stock 3 - Used |
The condition of the item. |
CurrentBid | decimal | positive # | The current bid on the item. |
CanOffer | boolean | true/false | Does the Item accept Offers? |
Description | string | string | The description and Standard Text of the item combined. |
DescriptionOnly | string | string | The description of the item. |
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. |
Fixed Priced | decimal | positive # | The fixed price of item. If 0, item is not a fixed price item. You should use the 'IsFixedPrice' property to determine if the item is a fixed price item. |
GTIN | string | string | The GTIN on the item. |
HasBuyNow | boolean | true/false | Does the item have a buy now? |
HasColor | boolean | true/false | Whether or not this item has the paid Colored Title feature. |
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? |
HasStarted | boolean | true/false | Has the item actually started? |
HasWinningBid | boolean | true/false | Is there a bid that will win this item? |
IsHighlighted | boolean | true/false | Whether or not this item has the paid Highlight feature. |
IsShowCaseItem | boolean | true/false | Whether or not this item has the paid Showcase Listing feature. |
IsTitleBoldface | boolean | true/false | Whether or not this item has the paid Boldface Title feature. |
IsWatching | boolean | true/false | Is the current user watching the item? |
InspectionPeriod | array key/value pair ( integer/string ) |
0-Unspecified 1 - AS IS or No refund or exchange 2 - No refund but item can be returned for exchange or store credit within 14 days 3 - No refund but item can be returned for exchange or store credit within 30 days 4 - 3 Days from the date the item is received 5 - 3 Days from the date the item is received, including the cost of shipping 6 - 5 Days from the date the item is received 7 - 5 Days from the date the item is received, including the cost of shipping 8 - 7 Days from the date the item is received 9 - 7 Days from the date the item is received, including the cost of shipping 10/ 14 Days from the date the item is received 11/ 14 Days from the date the item is received, including the cost of shipping 12 - 30 day money back guarantee 13 - 30 day money back guarantee including the cost of shipping 14 - Factory Warranty |
The valid inspection period for the the item. This is also the return policy |
IsActive | boolean | true/false | Is there a bid that will win this item? |
IsCurrentUserHighBidder | boolean | true/false | Is user logged into the RESTfulAPI the highbidder for this item? |
IsFFLRequired | boolean | true/false | Does this item require a FFL? |
IsFeaturedItem | boolean | true/false | Is this item featured? |
IsFixedPrice | boolean | true/false | Is this item a fixed price item? |
ItemCharacteristics | Item Characteristic | ItemCharacteristic | The item characteristics belonging to the item. |
Location | string | string | Location of the item. This is usually the city and state and postal code. |
MfgPartNumber | string | string | The manufacturing part number. |
MinimumBid | decimal | positive # | The minimum bid of the item. |
PaymentMethods | array key/pair ( integer/string ) |
1 - See Item Description 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 65536 - Freedom Coin (only returned for users that are allowed to buy with FreedomCoin) |
This lists out the valid payment methods the User will accept. |
Pictures | string array | An array of fully qualified urls to image files | The locations of images for the item |
Prop65Warning | string | string | California Proposition 65 warning (if applicable). For more information, visit https://www.p65warnings.ca.gov |
Quantity | integer | positive # | The number of items for sale for this item. |
RelistedAsItemID | string | string | The relisted item's ID if this item has been relisted, otherwise 0. |
RestrictRating | boolean | true/false | Indicates whether you are able to submit feedback on this item, and your options have been restricted |
SalesTaxes | array SalesTaxes | A list of states and sales tax belonging to that state | |
Seller | User Summary | User Summary | A user object containing User Summary information |
SerialNumber | string | string | The serial number of the item |
ShippingClassCost | array key/value pair ( integer/decimal ) |
1= Overnight - cost 2= 2nd Day - cost 4= 3rd Day - cost 8= Ground - cost 16= USPS 1st Class - cost 32= USPS Priority Mail - cost 64= Other - cost 125= In Store Pick Up - cost 256= Alaska, Hawaii & Terr., Non-Continental US, Other - cost |
Shipping cost belonging to each shipping class supported. See ShippingClassesSupported property |
ShippingClassesSupported | array key/value ( integer/string ) |
0 - None 1 - Overnight 2 - 2nd Day 4 - 3rd Day 8 - Ground 16 - USPS 1st Class 32 - USPS Priority Mail 64 - Other 128 - In Store Pick Up 256 - Alaska, Hawaii & Terr., Non-Continental US, Other |
The classes of shipping. |
SKU | string | string | The SKU of the item. |
StandardText | string | string | The Standard Text for Additional Terms of Sale of the item. |
StandardTextVersionID | int | int | The ID of the Standard Text for Additional Terms of Sale version linked to the item for StandardTextVersionID |
StartingBid | decimal | positive # | The starting bid of an item. |
StartingDate | datetime | Valid ISO 8601 DateTime format | The starting date time of the item in UTC. |
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. |
UPC | string | string | The UPC of the item. |
ViewCounter | integer | positive # | The number of times an item has been viewed or 0 (zero) if the paid feature hasn't been selected. |
Weight | decimal | positive # | The weight of the item. |
WeightUnit | array key/value pair ( integer/string ) |
1 - Pounds 2 - Kilograms |
The unit of weight of the item. |
WhoPaysForShipping | array key/value ( integer/string ) |
1 - See item description 2 - User pays for shipping ( free shipping ) 4 - Buyer pays actual 8 - Buyer pays fix amount 16 - Use Shipping profile |
Who pays for shipping. |
WillShipInternational | boolean | true/false | Will the User ship this item to an international country? |
Rel | Description | Condition |
---|---|---|
self | The item details | |
relisteditem | The relist of this item | The item has been relisted |
bid | Bid on the item | Only if bidding is currently available |
buynow | BuyNow! | Only if BuyNow! is currently available |
fixedprice | Buy a Fixed Price item | Only if FixedPrice is currently available |
watch | Put the item on a watched list | Only if the current User is not currently watching the item |
shippingestimate | GunBroker.com website shipping estimator | Only if the item is listed with a shipping profile |
picture | A link for each picture for the item | There will be one link for every picture for an item listing |
feedback | View the Seller's feedback summary | |
question | Ask the seller a question | |
sellersitems | View the Seller's other items |