Allows you to list an item for sale, including characteristics
|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.|
NOTE: Variables to place in the body of the request.
|Parameter||Data Type||Valid Values||Description|
|AllowLayaway||boolean||true/false||Specify if you offer layaway as a payment plan on this item.|
|AutoAcceptPrice||decimal||positive #||The minimum price for an offer to be automatically accepted.|
|AutoRejectPrice||decimal||positive #||The maximum price for an offer to be automatically rejected|
For an auction, this is the number of auto relists up to 999
For an auction to relist until sold, use 32000
For a fixed price listing to relist until quantity runs out, use 35000
Do not specify if no auto relist is required
|How the item should be relisted.|
|BuyNowPrice||decimal||positive #||Optional. The price you will sell the item for immediately. If used, the price must be greater than or equal to the Starting Bid and Reserve Price.|
|CanOffer||boolean||true/false||Specifies whether the item is enabled for offer functionality. If true, you must also send AutoAcceptPrice and AutoRejectPrice.|
|Category||integer||positive #||The single best category id for your item.|
|Characteristics||Array of Characteristics||An Array of values selected as this item's characteristics|
1 - Factory New
2 - New Old Stock
3 - Used
|The condition of the item.|
|CountryCode||string||2 character||The ISO 2 character country code where the item is located. For example:
|Description||string||string||The description of the item. If the description contains links or image references, they must all be secure (https://).|
|ExcludeStates||string||string||Comma separated list of two digit States where the seller has indicated they will not ship.|
|FFLRequired||boolean||true/false||Whether the item may only be shipped to a licensed Federal Firearms License (FFL) holder.|
|FixedPrice||decimal||positive #||Optional. The price of each item when selling fixed price items.|
|GTIN||string||string||Optional. The Global Trade Item Number (GTIN) of the item. If the GTIN is also a valid UPC and UPC is not specified, this will also update the UPC of the item.|
1 - AS IS - No refund or exchange
2 - No refund but item can be returned for exchange or store credit within fourteen days
3 - No refund but item can be returned for exchange or store credit within thirty days
4 - Three Days from the date the item is received
5 - Three Days from the date the item is received, including the cost of shipping
6 - Five Days from the date the item is received
7 - Five Days from the date the item is received, including the cost of shipping
8 - Seven Days from the date the item is received
9 - Seven Days from the date the item is received, including the cost of shipping
10 - Fourteen Days from the date the item is received
11 - Fourteen 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
|Optional. The return policy / inspection period for this listing|
1 - One day.
3 - Three days.
4 - Four days.
5 - Five days.
6 - Six days.
7 - Seven days.
8 - Eight days.
9 - Nine days.
10 - Ten days.
11 - Eleven days.
12 - Twelve days.
13 - Thirteen days.
14 - Fourteen days.
30 - Thirty days. (Fixed price items only)
60 - Sixty days. (Fixed price items only)
90 - Ninety days. (Fixed price items only)
|How long before the listing ends.
Please note for 1 and 3 day listings, a Reserve Price is not allowed
|MPN||string||string||The manufacturing part number.|
Amex - true/false
CertifiedCheck - true/false
Check - true/false
COD - true/false
Discover - true/false
Escrow - true/false
FreedomCoin - true/false (if allowed to sell)
MoneyOrder - true/false
PayPal - true/false
USPSMoneyOrder - true/false
VisaMastercard - true/false
The payment methods you will accept. Each object property is a boolean. For example:
Note: PaymentMethods will be ignored if your User account is configured for OutdoorPay.
|Pictures||string||Array of pictures to upload||
Optional. All picture URLs must be secure. Specify if image is uploaded by Aurigma or a hosted image
Optional. The premium features you want for the item listing. Please note there are additional charges for these features. For example:
NOTE: ScheduledStartingDate must be set in US Eastern Time ( GMT-5 ) Offical GunBroker Time
NOTE: ReservePrice will incur a fee. Please see the GunBroker Fees page for more information.
|Prop65Text||string||string||Optional. Place the appropriate Proposition 65 messaging here if this applies to your business and product. For more information, visit https://www.p65warnings.ca.gov|
|Quantity||integer||positive #||The quantity of items for sale. Must be 1 for auctions. Fixed price listings can have any quantity.|
|ReservePrice||decimal||positive #||Optional. The price the bidding must reach before you will sell the item.
Note: There is a fee for setting the reserve price. Please see the GunBroker Fees page for more information. Reserve price may not be set for 1 and 3 day listing durations.
|SerialNumber||string||string||Optional. The serial number of the item.|
Optional. The shipping costs for each supported shipping class. For example:
Overnight - true/false
TwoDay - true/false
ThreeDay - true/false
Ground - true/false
FirstClass - true/false
Priority - true/false
InStorePickup - true/false
AlaskaHawaii - true/false
Other - true/false
Required if not using a shipping profile. The shipping classes you support. Each object property is a boolean. For example:
|ShippingProfileID||integer||positive #||Optional. The shipping profile id to use to configure the available shipping options and costs for this item. If using a shipping profile,
2 - Seller Pays
4 - Buyer Pays Actual
8 - Buyer Pays Fixed
16 - Shipping Profile
|Specifies who pays for shipping on the item, or whether shipping fees are determined by a shipping profile.|
|SKU||string||string||Optional. The Stock Keeping Unit (SKU) of the item.|
|StandardTextID||int||int||The ID of the Standard Text for Additional Terms of Sale version linked to the item for StandardTextVersionID|
|StartingBid||decimal||positive #||Optional. The starting bid is the the least amount that a user will be able to bid on the item.|
|Title||string||string||The item title. 75 characters maximum, NO HTML, no asterisks, no quotes, NO ALL CAPS. Invalid characters will be stripped from the value entered.|
|UPC||string||string||Optional. The Universal Product Code (UPC) of the item. A valid UPC will add additional searchable characteristics to most firearm listings.|
|Weight||decimal||positive #||Optional. The weight of the item.|
1 - Pounds
2 - Kilograms
|Optional. The unit of weight for the item.|
|WillShipInternational||boolean||true/false||Whether you will ship the item internationally.|
|ZIPCode||string||string||The postal code where the item is located.|
If there are problems listing the item with these parameters, you will receive a
400 BadRequest and a JSON array of error messages indicating the reason(s).
If there are no errors with the input parameters, this call will respond with a
200 OK and a Message Response indicating the newly listed item number.
|self||URL to view item details as JSON|
|view||URL to view the item in a browser|