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.

GetGunBrokerCategoryList

Get our list of Categories

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.

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/GetGunBrokerCategoryList"

<?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>
    <GetGunBrokerCategoryList xmlns="GunBrokerAPI_V2" />
  </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>
    <GetGunBrokerCategoryListResponse xmlns="GunBrokerAPI_V2">
      <GetGunBrokerCategoryListResult>
        <Timestamp>dateTime</Timestamp>
        <Ack>Success or Failure or Warning</Ack>
        <Errors>
          <ShortMessage>string</ShortMessage>
          <LongMessage>string</LongMessage>
          <ErrorCode>string</ErrorCode>
        </Errors>
        <CategoryList>
          <CategoryDetailType>
            <CategoryID>int</CategoryID>
            <Name>string</Name>
            <ParentID>int</ParentID>
            <ParentName>string</ParentName>
            <Description>string</Description>
            <CanContainItems>boolean</CanContainItems>
            <FullIDPath>string</FullIDPath>
            <FullNamePath>string</FullNamePath>
            <ContainsCategories>string</ContainsCategories>
            <SubCategories>string</SubCategories>
          </CategoryDetailType>
          <CategoryDetailType>
            <CategoryID>int</CategoryID>
            <Name>string</Name>
            <ParentID>int</ParentID>
            <ParentName>string</ParentName>
            <Description>string</Description>
            <CanContainItems>boolean</CanContainItems>
            <FullIDPath>string</FullIDPath>
            <FullNamePath>string</FullNamePath>
            <ContainsCategories>string</ContainsCategories>
            <SubCategories>string</SubCategories>
          </CategoryDetailType>
        </CategoryList>
      </GetGunBrokerCategoryListResult>
    </GetGunBrokerCategoryListResponse>
  </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:Body>
    <GetGunBrokerCategoryList xmlns="GunBrokerAPI_V2" />
  </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>
    <GetGunBrokerCategoryListResponse xmlns="GunBrokerAPI_V2">
      <GetGunBrokerCategoryListResult>
        <Timestamp>dateTime</Timestamp>
        <Ack>Success or Failure or Warning</Ack>
        <Errors>
          <ShortMessage>string</ShortMessage>
          <LongMessage>string</LongMessage>
          <ErrorCode>string</ErrorCode>
        </Errors>
        <CategoryList>
          <CategoryDetailType>
            <CategoryID>int</CategoryID>
            <Name>string</Name>
            <ParentID>int</ParentID>
            <ParentName>string</ParentName>
            <Description>string</Description>
            <CanContainItems>boolean</CanContainItems>
            <FullIDPath>string</FullIDPath>
            <FullNamePath>string</FullNamePath>
            <ContainsCategories>string</ContainsCategories>
            <SubCategories>string</SubCategories>
          </CategoryDetailType>
          <CategoryDetailType>
            <CategoryID>int</CategoryID>
            <Name>string</Name>
            <ParentID>int</ParentID>
            <ParentName>string</ParentName>
            <Description>string</Description>
            <CanContainItems>boolean</CanContainItems>
            <FullIDPath>string</FullIDPath>
            <FullNamePath>string</FullNamePath>
            <ContainsCategories>string</ContainsCategories>
            <SubCategories>string</SubCategories>
          </CategoryDetailType>
        </CategoryList>
      </GetGunBrokerCategoryListResult>
    </GetGunBrokerCategoryListResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

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

GET /AuctionService.asmx/GetGunBrokerCategoryList? HTTP/1.1
Host: apiv2.gunbroker.com
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<GetCategoryListResponseType xmlns="GunBrokerAPI_V2">
  <Timestamp>dateTime</Timestamp>
  <Ack>Success or Failure or Warning</Ack>
  <Errors>
    <ShortMessage>string</ShortMessage>
    <LongMessage>string</LongMessage>
    <ErrorCode>string</ErrorCode>
  </Errors>
  <CategoryList>
    <CategoryDetailType>
      <CategoryID>int</CategoryID>
      <Name>string</Name>
      <ParentID>int</ParentID>
      <ParentName>string</ParentName>
      <Description>string</Description>
      <CanContainItems>boolean</CanContainItems>
      <FullIDPath>string</FullIDPath>
      <FullNamePath>string</FullNamePath>
      <ContainsCategories>string</ContainsCategories>
      <SubCategories>string</SubCategories>
    </CategoryDetailType>
    <CategoryDetailType>
      <CategoryID>int</CategoryID>
      <Name>string</Name>
      <ParentID>int</ParentID>
      <ParentName>string</ParentName>
      <Description>string</Description>
      <CanContainItems>boolean</CanContainItems>
      <FullIDPath>string</FullIDPath>
      <FullNamePath>string</FullNamePath>
      <ContainsCategories>string</ContainsCategories>
      <SubCategories>string</SubCategories>
    </CategoryDetailType>
  </CategoryList>
</GetCategoryListResponseType>

HTTP POST

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

POST /AuctionService.asmx/GetGunBrokerCategoryList HTTP/1.1
Host: apiv2.gunbroker.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<GetCategoryListResponseType xmlns="GunBrokerAPI_V2">
  <Timestamp>dateTime</Timestamp>
  <Ack>Success or Failure or Warning</Ack>
  <Errors>
    <ShortMessage>string</ShortMessage>
    <LongMessage>string</LongMessage>
    <ErrorCode>string</ErrorCode>
  </Errors>
  <CategoryList>
    <CategoryDetailType>
      <CategoryID>int</CategoryID>
      <Name>string</Name>
      <ParentID>int</ParentID>
      <ParentName>string</ParentName>
      <Description>string</Description>
      <CanContainItems>boolean</CanContainItems>
      <FullIDPath>string</FullIDPath>
      <FullNamePath>string</FullNamePath>
      <ContainsCategories>string</ContainsCategories>
      <SubCategories>string</SubCategories>
    </CategoryDetailType>
    <CategoryDetailType>
      <CategoryID>int</CategoryID>
      <Name>string</Name>
      <ParentID>int</ParentID>
      <ParentName>string</ParentName>
      <Description>string</Description>
      <CanContainItems>boolean</CanContainItems>
      <FullIDPath>string</FullIDPath>
      <FullNamePath>string</FullNamePath>
      <ContainsCategories>string</ContainsCategories>
      <SubCategories>string</SubCategories>
    </CategoryDetailType>
  </CategoryList>
</GetCategoryListResponseType>