GunBroker.com Auctions Web Service

The GunBroker.com SOAP API will be deprecated.  Please start using our REST API for your applications.

Click here for a complete list of operations.

AddItem

Create a new, uncommitted auction listing. Uncommitted auction listings are temporary auction listings that are hidden and not open for bidding. Uncommitted auctions are removed after a few days. You can test your software integration with our Web Service by creating auction listings without calling AddItemCommit. Call AddItemCommit to confirm that you want to create the auction listing and open the auction for bidding.

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /AuctionService.asmx HTTP/1.1
Host: apiv2.gunbroker.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "GunBrokerAPI_V2/AddItem"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <RequesterCredentials xmlns="GunBrokerAPI_V2">
      <DevKey>string</DevKey>
      <AppKey>string</AppKey>
    </RequesterCredentials>
  </soap:Header>
  <soap:Body>
    <AddItem xmlns="GunBrokerAPI_V2">
      <item>
        <PrimaryCategory>int</PrimaryCategory>
        <SecondaryCategory>int</SecondaryCategory>
        <Title>string</Title>
        <Subtitle>string</Subtitle>
        <Description>string</Description>
        <PostalCode>string</PostalCode>
        <StateCode>string</StateCode>
        <CountryCode>string</CountryCode>
        <ListingDuration>Unspecified or One_Day or Three_Day or Five_Day or Seven_Day or Nine_Day or Ten_Day or Eleven_Day or Twelve_Day or Thirteen_Day or Fourteen_Day or Thirty_Day or Sixty_Day or Ninety_Day</ListingDuration>
        <Quantity>int</Quantity>
        <ItemCondition>Unspecified or Factory_New or New_Old_Stock or Used</ItemCondition>
        <ItemConditionText>string</ItemConditionText>
        <InspectionPeriod>Unspecified or As_Is or Fourteen_Day_Store_Credit or Thirty_Day_Store_Credit or Three_Day or Three_Day_With_Shipping or Five_Day or Five_Day_With_Shipping or Seven_Day or Seven_Day_With_Shipping or Fourteen_Day or Fourteen_Day_With_Shipping or Thirty_Day_Money_Back or Thirty_Day_Money_Back_With_Shipping</InspectionPeriod>
        <InspectionPeriodText>string</InspectionPeriodText>
        <StartPrice>decimal</StartPrice>
        <ReservePrice>decimal</ReservePrice>
        <BuyNowPrice>decimal</BuyNowPrice>
        <FixedPrice>decimal</FixedPrice>
        <PaymentOptions>
          <SeeItemDesc>boolean</SeeItemDesc>
          <CertifiedFunds>boolean</CertifiedFunds>
          <Check>boolean</Check>
          <VisaMastercard>boolean</VisaMastercard>
          <COD>boolean</COD>
          <Escrow>boolean</Escrow>
          <Amex>boolean</Amex>
          <Discover>boolean</Discover>
          <WireTransfer>boolean</WireTransfer>
          <PayPal>boolean</PayPal>
          <Bidpay>boolean</Bidpay>
          <USPSMoneyOrder>boolean</USPSMoneyOrder>
          <MoneyOrder>boolean</MoneyOrder>
          <CertifiedCheck>boolean</CertifiedCheck>
        </PaymentOptions>
        <ShipInternational>boolean</ShipInternational>
        <ShippingPayment>Unspecified or Buyer_Pays_Actual or Seller_Pays or Buyer_Pays_Fixed</ShippingPayment>
        <CollectSalesTax>Unspecified or Collected or Not_Collected</CollectSalesTax>
        <AutoRelist>Unspecified or Do_Not_Relist or Relist_Until_Sold or Relist_Fixed_Count</AutoRelist>
        <AutoRelistFixedCount>int</AutoRelistFixedCount>
        <ListingEnhancement>
          <HomePageFeatured>boolean</HomePageFeatured>
          <Featured>boolean</Featured>
          <Thumbnail>boolean</Thumbnail>
          <Counter>boolean</Counter>
          <Highlight>boolean</Highlight>
          <BoldTitle>boolean</BoldTitle>
          <QuickLook>boolean</QuickLook>
          <ColoredTitle>boolean</ColoredTitle>
          <TitleColor>Unspecified or Green or Blue or Red</TitleColor>
        </ListingEnhancement>
        <SKU>string</SKU>
        <UPC>string</UPC>
        <ReserveMet>boolean</ReserveMet>
        <HasReserve>boolean</HasReserve>
        <SalesPending>int</SalesPending>
        <CurrentBid>decimal</CurrentBid>
        <StartDate>dateTime</StartDate>
        <IsScheduled>boolean</IsScheduled>
        <RequiresFFL>boolean</RequiresFFL>
        <SerialNumber>string</SerialNumber>
        <ShippingProfileID>int</ShippingProfileID>
        <Weight>decimal</Weight>
        <WeightUnit>None or Pounds or Kilograms</WeightUnit>
        <EligibleForImmediateCheckout>boolean</EligibleForImmediateCheckout>
        <Pictures>
          <ArrayOfAnyType>
            <anyType />
            <anyType />
          </ArrayOfAnyType>
          <ArrayOfAnyType>
            <anyType />
            <anyType />
          </ArrayOfAnyType>
        </Pictures>
        <PictureURL>
          <string>string</string>
          <string>string</string>
        </PictureURL>
        <HasPictures>boolean</HasPictures>
        <ShippingClassesSupported>
          <ShipperClassEnum>None or Overnight or Two_Day or Three_Day or Ground or First_Class or Priority or Other</ShipperClassEnum>
          <ShipperClassEnum>None or Overnight or Two_Day or Three_Day or Ground or First_Class or Priority or Other</ShipperClassEnum>
        </ShippingClassesSupported>
        <ShippingCosts>
          <ShippingCostType>
            <ShipperClass>None or Overnight or Two_Day or Three_Day or Ground or First_Class or Priority or Other</ShipperClass>
            <FixedCost>decimal</FixedCost>
          </ShippingCostType>
          <ShippingCostType>
            <ShipperClass>None or Overnight or Two_Day or Three_Day or Ground or First_Class or Priority or Other</ShipperClass>
            <FixedCost>decimal</FixedCost>
          </ShippingCostType>
        </ShippingCosts>
        <SalesTaxStateTypes>
          <SalesTaxStateType>
            <State>string</State>
            <TaxRate>decimal</TaxRate>
          </SalesTaxStateType>
          <SalesTaxStateType>
            <State>string</State>
            <TaxRate>decimal</TaxRate>
          </SalesTaxStateType>
        </SalesTaxStateTypes>
      </item>
    </AddItem>
  </soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <AddItemResponse xmlns="GunBrokerAPI_V2">
      <AddItemResult>
        <Timestamp>dateTime</Timestamp>
        <Ack>Success or Failure or Warning</Ack>
        <Errors>
          <ShortMessage>string</ShortMessage>
          <LongMessage>string</LongMessage>
          <ErrorCode>string</ErrorCode>
        </Errors>
        <UncommittedItemID>int</UncommittedItemID>
        <ItemID>int</ItemID>
        <StartTime>dateTime</StartTime>
        <EndTime>dateTime</EndTime>
      </AddItemResult>
    </AddItemResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /AuctionService.asmx HTTP/1.1
Host: apiv2.gunbroker.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Header>
    <RequesterCredentials xmlns="GunBrokerAPI_V2">
      <DevKey>string</DevKey>
      <AppKey>string</AppKey>
    </RequesterCredentials>
  </soap12:Header>
  <soap12:Body>
    <AddItem xmlns="GunBrokerAPI_V2">
      <item>
        <PrimaryCategory>int</PrimaryCategory>
        <SecondaryCategory>int</SecondaryCategory>
        <Title>string</Title>
        <Subtitle>string</Subtitle>
        <Description>string</Description>
        <PostalCode>string</PostalCode>
        <StateCode>string</StateCode>
        <CountryCode>string</CountryCode>
        <ListingDuration>Unspecified or One_Day or Three_Day or Five_Day or Seven_Day or Nine_Day or Ten_Day or Eleven_Day or Twelve_Day or Thirteen_Day or Fourteen_Day or Thirty_Day or Sixty_Day or Ninety_Day</ListingDuration>
        <Quantity>int</Quantity>
        <ItemCondition>Unspecified or Factory_New or New_Old_Stock or Used</ItemCondition>
        <ItemConditionText>string</ItemConditionText>
        <InspectionPeriod>Unspecified or As_Is or Fourteen_Day_Store_Credit or Thirty_Day_Store_Credit or Three_Day or Three_Day_With_Shipping or Five_Day or Five_Day_With_Shipping or Seven_Day or Seven_Day_With_Shipping or Fourteen_Day or Fourteen_Day_With_Shipping or Thirty_Day_Money_Back or Thirty_Day_Money_Back_With_Shipping</InspectionPeriod>
        <InspectionPeriodText>string</InspectionPeriodText>
        <StartPrice>decimal</StartPrice>
        <ReservePrice>decimal</ReservePrice>
        <BuyNowPrice>decimal</BuyNowPrice>
        <FixedPrice>decimal</FixedPrice>
        <PaymentOptions>
          <SeeItemDesc>boolean</SeeItemDesc>
          <CertifiedFunds>boolean</CertifiedFunds>
          <Check>boolean</Check>
          <VisaMastercard>boolean</VisaMastercard>
          <COD>boolean</COD>
          <Escrow>boolean</Escrow>
          <Amex>boolean</Amex>
          <Discover>boolean</Discover>
          <WireTransfer>boolean</WireTransfer>
          <PayPal>boolean</PayPal>
          <Bidpay>boolean</Bidpay>
          <USPSMoneyOrder>boolean</USPSMoneyOrder>
          <MoneyOrder>boolean</MoneyOrder>
          <CertifiedCheck>boolean</CertifiedCheck>
        </PaymentOptions>
        <ShipInternational>boolean</ShipInternational>
        <ShippingPayment>Unspecified or Buyer_Pays_Actual or Seller_Pays or Buyer_Pays_Fixed</ShippingPayment>
        <CollectSalesTax>Unspecified or Collected or Not_Collected</CollectSalesTax>
        <AutoRelist>Unspecified or Do_Not_Relist or Relist_Until_Sold or Relist_Fixed_Count</AutoRelist>
        <AutoRelistFixedCount>int</AutoRelistFixedCount>
        <ListingEnhancement>
          <HomePageFeatured>boolean</HomePageFeatured>
          <Featured>boolean</Featured>
          <Thumbnail>boolean</Thumbnail>
          <Counter>boolean</Counter>
          <Highlight>boolean</Highlight>
          <BoldTitle>boolean</BoldTitle>
          <QuickLook>boolean</QuickLook>
          <ColoredTitle>boolean</ColoredTitle>
          <TitleColor>Unspecified or Green or Blue or Red</TitleColor>
        </ListingEnhancement>
        <SKU>string</SKU>
        <UPC>string</UPC>
        <ReserveMet>boolean</ReserveMet>
        <HasReserve>boolean</HasReserve>
        <SalesPending>int</SalesPending>
        <CurrentBid>decimal</CurrentBid>
        <StartDate>dateTime</StartDate>
        <IsScheduled>boolean</IsScheduled>
        <RequiresFFL>boolean</RequiresFFL>
        <SerialNumber>string</SerialNumber>
        <ShippingProfileID>int</ShippingProfileID>
        <Weight>decimal</Weight>
        <WeightUnit>None or Pounds or Kilograms</WeightUnit>
        <EligibleForImmediateCheckout>boolean</EligibleForImmediateCheckout>
        <Pictures>
          <ArrayOfAnyType>
            <anyType />
            <anyType />
          </ArrayOfAnyType>
          <ArrayOfAnyType>
            <anyType />
            <anyType />
          </ArrayOfAnyType>
        </Pictures>
        <PictureURL>
          <string>string</string>
          <string>string</string>
        </PictureURL>
        <HasPictures>boolean</HasPictures>
        <ShippingClassesSupported>
          <ShipperClassEnum>None or Overnight or Two_Day or Three_Day or Ground or First_Class or Priority or Other</ShipperClassEnum>
          <ShipperClassEnum>None or Overnight or Two_Day or Three_Day or Ground or First_Class or Priority or Other</ShipperClassEnum>
        </ShippingClassesSupported>
        <ShippingCosts>
          <ShippingCostType>
            <ShipperClass>None or Overnight or Two_Day or Three_Day or Ground or First_Class or Priority or Other</ShipperClass>
            <FixedCost>decimal</FixedCost>
          </ShippingCostType>
          <ShippingCostType>
            <ShipperClass>None or Overnight or Two_Day or Three_Day or Ground or First_Class or Priority or Other</ShipperClass>
            <FixedCost>decimal</FixedCost>
          </ShippingCostType>
        </ShippingCosts>
        <SalesTaxStateTypes>
          <SalesTaxStateType>
            <State>string</State>
            <TaxRate>decimal</TaxRate>
          </SalesTaxStateType>
          <SalesTaxStateType>
            <State>string</State>
            <TaxRate>decimal</TaxRate>
          </SalesTaxStateType>
        </SalesTaxStateTypes>
      </item>
    </AddItem>
  </soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <AddItemResponse xmlns="GunBrokerAPI_V2">
      <AddItemResult>
        <Timestamp>dateTime</Timestamp>
        <Ack>Success or Failure or Warning</Ack>
        <Errors>
          <ShortMessage>string</ShortMessage>
          <LongMessage>string</LongMessage>
          <ErrorCode>string</ErrorCode>
        </Errors>
        <UncommittedItemID>int</UncommittedItemID>
        <ItemID>int</ItemID>
        <StartTime>dateTime</StartTime>
        <EndTime>dateTime</EndTime>
      </AddItemResult>
    </AddItemResponse>
  </soap12:Body>
</soap12:Envelope>