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.

GetChildren

Returns all child item numbers for a particular item. A single item can be relisted multiple times and thus have multiple children. For example, if item 100 is relisted as 101, 105, and 106, calling this method and passing 100 would return an array containing 101, 105, and 106. This method only goes down one level in the item hierarchy. If item 101 is relisted as 109, then 109 would not be included in the result set if you passed 100 to this method. It would, however, be included if you called the method for item 101.

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.
Parameter Value
ItemNumber:

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

<?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>
    <GetChildren xmlns="GunBrokerAPI_V2">
      <ItemNumber>int</ItemNumber>
    </GetChildren>
  </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>
    <GetChildrenResponse xmlns="GunBrokerAPI_V2">
      <GetChildrenResult>
        <Timestamp>dateTime</Timestamp>
        <Ack>Success or Failure or Warning</Ack>
        <Errors>
          <ShortMessage>string</ShortMessage>
          <LongMessage>string</LongMessage>
          <ErrorCode>string</ErrorCode>
        </Errors>
        <Children>
          <int>int</int>
          <int>int</int>
        </Children>
      </GetChildrenResult>
    </GetChildrenResponse>
  </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>
    <GetChildren xmlns="GunBrokerAPI_V2">
      <ItemNumber>int</ItemNumber>
    </GetChildren>
  </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>
    <GetChildrenResponse xmlns="GunBrokerAPI_V2">
      <GetChildrenResult>
        <Timestamp>dateTime</Timestamp>
        <Ack>Success or Failure or Warning</Ack>
        <Errors>
          <ShortMessage>string</ShortMessage>
          <LongMessage>string</LongMessage>
          <ErrorCode>string</ErrorCode>
        </Errors>
        <Children>
          <int>int</int>
          <int>int</int>
        </Children>
      </GetChildrenResult>
    </GetChildrenResponse>
  </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/GetChildren?ItemNumber=string 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"?>
<GetChildrenResponseType xmlns="GunBrokerAPI_V2">
  <Timestamp>dateTime</Timestamp>
  <Ack>Success or Failure or Warning</Ack>
  <Errors>
    <ShortMessage>string</ShortMessage>
    <LongMessage>string</LongMessage>
    <ErrorCode>string</ErrorCode>
  </Errors>
  <Children>
    <int>int</int>
    <int>int</int>
  </Children>
</GetChildrenResponseType>

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/GetChildren HTTP/1.1
Host: apiv2.gunbroker.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

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

<?xml version="1.0" encoding="utf-8"?>
<GetChildrenResponseType xmlns="GunBrokerAPI_V2">
  <Timestamp>dateTime</Timestamp>
  <Ack>Success or Failure or Warning</Ack>
  <Errors>
    <ShortMessage>string</ShortMessage>
    <LongMessage>string</LongMessage>
    <ErrorCode>string</ErrorCode>
  </Errors>
  <Children>
    <int>int</int>
    <int>int</int>
  </Children>
</GetChildrenResponseType>