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.

GetOrder

Gets an order belonging to the orderID passed in. You must be the buyer or seller of the order to get the order returned.

Test

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

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

<?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>
    <GetOrder xmlns="GunBrokerAPI_V2">
      <orderID>int</orderID>
    </GetOrder>
  </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>
    <GetOrderResponse xmlns="GunBrokerAPI_V2">
      <GetOrderResult>
        <Timestamp>dateTime</Timestamp>
        <Ack>Success or Failure or Warning</Ack>
        <Errors>
          <ShortMessage>string</ShortMessage>
          <LongMessage>string</LongMessage>
          <ErrorCode>string</ErrorCode>
        </Errors>
        <Order>
          <OrderID>int</OrderID>
          <CreateDate>dateTime</CreateDate>
          <CancelDate>dateTime</CancelDate>
          <SellerOrderID>string</SellerOrderID>
          <Status />
          <BuyerReviewedDate>dateTime</BuyerReviewedDate>
          <SellerReviewCompleteDate>dateTime</SellerReviewCompleteDate>
          <BuyerConfirmationDate>dateTime</BuyerConfirmationDate>
          <PaymentReceivedDate>dateTime</PaymentReceivedDate>
          <FFLReceivedDate>dateTime</FFLReceivedDate>
          <ShipDate>dateTime</ShipDate>
          <MiscCharge>decimal</MiscCharge>
          <MiscDescription>string</MiscDescription>
          <PaymentMethod>None or See_Item_Desc or Certified_Funds or Check or Visa_Mastercard or COD or Escrow or Amex or Discover or Wire_Transfer or PayPal or Bidpay or Credit_Card or Cash or PayCertifiedCheck or PayUSPSMoneyOrder or PayMoneyOrder</PaymentMethod>
          <BuyerUserName>string</BuyerUserName>
          <BillToName>string</BillToName>
          <BillToAddress1>string</BillToAddress1>
          <BillToAddress2>string</BillToAddress2>
          <BillToCity>string</BillToCity>
          <BillToState>string</BillToState>
          <BillToPostalCode>string</BillToPostalCode>
          <BillToCountryCode>string</BillToCountryCode>
          <BillToPhone>string</BillToPhone>
          <BillToEmail>string</BillToEmail>
          <ShipToName>string</ShipToName>
          <ShipToAddress1>string</ShipToAddress1>
          <ShipToAddress2>string</ShipToAddress2>
          <ShipToCity>string</ShipToCity>
          <ShipToState>string</ShipToState>
          <ShipToPostalCode>string</ShipToPostalCode>
          <ShipToCountryCode>string</ShipToCountryCode>
          <ShipToPhone>string</ShipToPhone>
          <ShipToEmail>string</ShipToEmail>
          <ShipFromName>string</ShipFromName>
          <ShipFromAddress1>string</ShipFromAddress1>
          <ShipFromAddress2>string</ShipFromAddress2>
          <ShipFromCity>string</ShipFromCity>
          <ShipFromState>string</ShipFromState>
          <ShipFromPostalCode>string</ShipFromPostalCode>
          <ShipFromCountryCode>string</ShipFromCountryCode>
          <ShipFromPhone>string</ShipFromPhone>
          <ShipFromEmail>string</ShipFromEmail>
          <ShippingCarrier>string</ShippingCarrier>
          <ShippingClass>None or Overnight or Two_Day or Three_Day or Ground or First_Class or Priority or Other</ShippingClass>
          <ShippingCosts>decimal</ShippingCosts>
          <ShippingHandlingCost>decimal</ShippingHandlingCost>
          <ShippingInsuranceCost>decimal</ShippingInsuranceCost>
          <IsOrderInsured>boolean</IsOrderInsured>
          <TrackingNumber>string</TrackingNumber>
          <FFLNumber>string</FFLNumber>
          <LostCashDiscount>decimal</LostCashDiscount>
          <OrderTotal>decimal</OrderTotal>
          <OrderItems>
            <OrderItemType>
              <ItemID>int</ItemID>
              <ItemTitle>string</ItemTitle>
              <ItemPrice>decimal</ItemPrice>
              <Quantity>int</Quantity>
              <SalesTax>decimal</SalesTax>
              <SalesTaxRate>decimal</SalesTaxRate>
              <ShippingProfileID>int</ShippingProfileID>
              <Weight>decimal</Weight>
              <WeightUnit>None or Pounds or Kilograms</WeightUnit>
              <ItemSubTotal>decimal</ItemSubTotal>
            </OrderItemType>
            <OrderItemType>
              <ItemID>int</ItemID>
              <ItemTitle>string</ItemTitle>
              <ItemPrice>decimal</ItemPrice>
              <Quantity>int</Quantity>
              <SalesTax>decimal</SalesTax>
              <SalesTaxRate>decimal</SalesTaxRate>
              <ShippingProfileID>int</ShippingProfileID>
              <Weight>decimal</Weight>
              <WeightUnit>None or Pounds or Kilograms</WeightUnit>
              <ItemSubTotal>decimal</ItemSubTotal>
            </OrderItemType>
          </OrderItems>
        </Order>
      </GetOrderResult>
    </GetOrderResponse>
  </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>
    <GetOrder xmlns="GunBrokerAPI_V2">
      <orderID>int</orderID>
    </GetOrder>
  </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>
    <GetOrderResponse xmlns="GunBrokerAPI_V2">
      <GetOrderResult>
        <Timestamp>dateTime</Timestamp>
        <Ack>Success or Failure or Warning</Ack>
        <Errors>
          <ShortMessage>string</ShortMessage>
          <LongMessage>string</LongMessage>
          <ErrorCode>string</ErrorCode>
        </Errors>
        <Order>
          <OrderID>int</OrderID>
          <CreateDate>dateTime</CreateDate>
          <CancelDate>dateTime</CancelDate>
          <SellerOrderID>string</SellerOrderID>
          <Status />
          <BuyerReviewedDate>dateTime</BuyerReviewedDate>
          <SellerReviewCompleteDate>dateTime</SellerReviewCompleteDate>
          <BuyerConfirmationDate>dateTime</BuyerConfirmationDate>
          <PaymentReceivedDate>dateTime</PaymentReceivedDate>
          <FFLReceivedDate>dateTime</FFLReceivedDate>
          <ShipDate>dateTime</ShipDate>
          <MiscCharge>decimal</MiscCharge>
          <MiscDescription>string</MiscDescription>
          <PaymentMethod>None or See_Item_Desc or Certified_Funds or Check or Visa_Mastercard or COD or Escrow or Amex or Discover or Wire_Transfer or PayPal or Bidpay or Credit_Card or Cash or PayCertifiedCheck or PayUSPSMoneyOrder or PayMoneyOrder</PaymentMethod>
          <BuyerUserName>string</BuyerUserName>
          <BillToName>string</BillToName>
          <BillToAddress1>string</BillToAddress1>
          <BillToAddress2>string</BillToAddress2>
          <BillToCity>string</BillToCity>
          <BillToState>string</BillToState>
          <BillToPostalCode>string</BillToPostalCode>
          <BillToCountryCode>string</BillToCountryCode>
          <BillToPhone>string</BillToPhone>
          <BillToEmail>string</BillToEmail>
          <ShipToName>string</ShipToName>
          <ShipToAddress1>string</ShipToAddress1>
          <ShipToAddress2>string</ShipToAddress2>
          <ShipToCity>string</ShipToCity>
          <ShipToState>string</ShipToState>
          <ShipToPostalCode>string</ShipToPostalCode>
          <ShipToCountryCode>string</ShipToCountryCode>
          <ShipToPhone>string</ShipToPhone>
          <ShipToEmail>string</ShipToEmail>
          <ShipFromName>string</ShipFromName>
          <ShipFromAddress1>string</ShipFromAddress1>
          <ShipFromAddress2>string</ShipFromAddress2>
          <ShipFromCity>string</ShipFromCity>
          <ShipFromState>string</ShipFromState>
          <ShipFromPostalCode>string</ShipFromPostalCode>
          <ShipFromCountryCode>string</ShipFromCountryCode>
          <ShipFromPhone>string</ShipFromPhone>
          <ShipFromEmail>string</ShipFromEmail>
          <ShippingCarrier>string</ShippingCarrier>
          <ShippingClass>None or Overnight or Two_Day or Three_Day or Ground or First_Class or Priority or Other</ShippingClass>
          <ShippingCosts>decimal</ShippingCosts>
          <ShippingHandlingCost>decimal</ShippingHandlingCost>
          <ShippingInsuranceCost>decimal</ShippingInsuranceCost>
          <IsOrderInsured>boolean</IsOrderInsured>
          <TrackingNumber>string</TrackingNumber>
          <FFLNumber>string</FFLNumber>
          <LostCashDiscount>decimal</LostCashDiscount>
          <OrderTotal>decimal</OrderTotal>
          <OrderItems>
            <OrderItemType>
              <ItemID>int</ItemID>
              <ItemTitle>string</ItemTitle>
              <ItemPrice>decimal</ItemPrice>
              <Quantity>int</Quantity>
              <SalesTax>decimal</SalesTax>
              <SalesTaxRate>decimal</SalesTaxRate>
              <ShippingProfileID>int</ShippingProfileID>
              <Weight>decimal</Weight>
              <WeightUnit>None or Pounds or Kilograms</WeightUnit>
              <ItemSubTotal>decimal</ItemSubTotal>
            </OrderItemType>
            <OrderItemType>
              <ItemID>int</ItemID>
              <ItemTitle>string</ItemTitle>
              <ItemPrice>decimal</ItemPrice>
              <Quantity>int</Quantity>
              <SalesTax>decimal</SalesTax>
              <SalesTaxRate>decimal</SalesTaxRate>
              <ShippingProfileID>int</ShippingProfileID>
              <Weight>decimal</Weight>
              <WeightUnit>None or Pounds or Kilograms</WeightUnit>
              <ItemSubTotal>decimal</ItemSubTotal>
            </OrderItemType>
          </OrderItems>
        </Order>
      </GetOrderResult>
    </GetOrderResponse>
  </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/GetOrder?orderID=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"?>
<OrderResponseType xmlns="GunBrokerAPI_V2">
  <Timestamp>dateTime</Timestamp>
  <Ack>Success or Failure or Warning</Ack>
  <Errors>
    <ShortMessage>string</ShortMessage>
    <LongMessage>string</LongMessage>
    <ErrorCode>string</ErrorCode>
  </Errors>
  <Order>
    <OrderID>int</OrderID>
    <CreateDate>dateTime</CreateDate>
    <CancelDate>dateTime</CancelDate>
    <SellerOrderID>string</SellerOrderID>
    <Status />
    <BuyerReviewedDate>dateTime</BuyerReviewedDate>
    <SellerReviewCompleteDate>dateTime</SellerReviewCompleteDate>
    <BuyerConfirmationDate>dateTime</BuyerConfirmationDate>
    <PaymentReceivedDate>dateTime</PaymentReceivedDate>
    <FFLReceivedDate>dateTime</FFLReceivedDate>
    <ShipDate>dateTime</ShipDate>
    <MiscCharge>decimal</MiscCharge>
    <MiscDescription>string</MiscDescription>
    <PaymentMethod>None or See_Item_Desc or Certified_Funds or Check or Visa_Mastercard or COD or Escrow or Amex or Discover or Wire_Transfer or PayPal or Bidpay or Credit_Card or Cash or PayCertifiedCheck or PayUSPSMoneyOrder or PayMoneyOrder</PaymentMethod>
    <BuyerUserName>string</BuyerUserName>
    <BillToName>string</BillToName>
    <BillToAddress1>string</BillToAddress1>
    <BillToAddress2>string</BillToAddress2>
    <BillToCity>string</BillToCity>
    <BillToState>string</BillToState>
    <BillToPostalCode>string</BillToPostalCode>
    <BillToCountryCode>string</BillToCountryCode>
    <BillToPhone>string</BillToPhone>
    <BillToEmail>string</BillToEmail>
    <ShipToName>string</ShipToName>
    <ShipToAddress1>string</ShipToAddress1>
    <ShipToAddress2>string</ShipToAddress2>
    <ShipToCity>string</ShipToCity>
    <ShipToState>string</ShipToState>
    <ShipToPostalCode>string</ShipToPostalCode>
    <ShipToCountryCode>string</ShipToCountryCode>
    <ShipToPhone>string</ShipToPhone>
    <ShipToEmail>string</ShipToEmail>
    <ShipFromName>string</ShipFromName>
    <ShipFromAddress1>string</ShipFromAddress1>
    <ShipFromAddress2>string</ShipFromAddress2>
    <ShipFromCity>string</ShipFromCity>
    <ShipFromState>string</ShipFromState>
    <ShipFromPostalCode>string</ShipFromPostalCode>
    <ShipFromCountryCode>string</ShipFromCountryCode>
    <ShipFromPhone>string</ShipFromPhone>
    <ShipFromEmail>string</ShipFromEmail>
    <ShippingCarrier>string</ShippingCarrier>
    <ShippingClass>None or Overnight or Two_Day or Three_Day or Ground or First_Class or Priority or Other</ShippingClass>
    <ShippingCosts>decimal</ShippingCosts>
    <ShippingHandlingCost>decimal</ShippingHandlingCost>
    <ShippingInsuranceCost>decimal</ShippingInsuranceCost>
    <IsOrderInsured>boolean</IsOrderInsured>
    <TrackingNumber>string</TrackingNumber>
    <FFLNumber>string</FFLNumber>
    <LostCashDiscount>decimal</LostCashDiscount>
    <OrderTotal>decimal</OrderTotal>
    <OrderItems>
      <OrderItemType>
        <ItemID>int</ItemID>
        <ItemTitle>string</ItemTitle>
        <ItemPrice>decimal</ItemPrice>
        <Quantity>int</Quantity>
        <SalesTax>decimal</SalesTax>
        <SalesTaxRate>decimal</SalesTaxRate>
        <ShippingProfileID>int</ShippingProfileID>
        <Weight>decimal</Weight>
        <WeightUnit>None or Pounds or Kilograms</WeightUnit>
        <ItemSubTotal>decimal</ItemSubTotal>
      </OrderItemType>
      <OrderItemType>
        <ItemID>int</ItemID>
        <ItemTitle>string</ItemTitle>
        <ItemPrice>decimal</ItemPrice>
        <Quantity>int</Quantity>
        <SalesTax>decimal</SalesTax>
        <SalesTaxRate>decimal</SalesTaxRate>
        <ShippingProfileID>int</ShippingProfileID>
        <Weight>decimal</Weight>
        <WeightUnit>None or Pounds or Kilograms</WeightUnit>
        <ItemSubTotal>decimal</ItemSubTotal>
      </OrderItemType>
    </OrderItems>
  </Order>
</OrderResponseType>

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

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

<?xml version="1.0" encoding="utf-8"?>
<OrderResponseType xmlns="GunBrokerAPI_V2">
  <Timestamp>dateTime</Timestamp>
  <Ack>Success or Failure or Warning</Ack>
  <Errors>
    <ShortMessage>string</ShortMessage>
    <LongMessage>string</LongMessage>
    <ErrorCode>string</ErrorCode>
  </Errors>
  <Order>
    <OrderID>int</OrderID>
    <CreateDate>dateTime</CreateDate>
    <CancelDate>dateTime</CancelDate>
    <SellerOrderID>string</SellerOrderID>
    <Status />
    <BuyerReviewedDate>dateTime</BuyerReviewedDate>
    <SellerReviewCompleteDate>dateTime</SellerReviewCompleteDate>
    <BuyerConfirmationDate>dateTime</BuyerConfirmationDate>
    <PaymentReceivedDate>dateTime</PaymentReceivedDate>
    <FFLReceivedDate>dateTime</FFLReceivedDate>
    <ShipDate>dateTime</ShipDate>
    <MiscCharge>decimal</MiscCharge>
    <MiscDescription>string</MiscDescription>
    <PaymentMethod>None or See_Item_Desc or Certified_Funds or Check or Visa_Mastercard or COD or Escrow or Amex or Discover or Wire_Transfer or PayPal or Bidpay or Credit_Card or Cash or PayCertifiedCheck or PayUSPSMoneyOrder or PayMoneyOrder</PaymentMethod>
    <BuyerUserName>string</BuyerUserName>
    <BillToName>string</BillToName>
    <BillToAddress1>string</BillToAddress1>
    <BillToAddress2>string</BillToAddress2>
    <BillToCity>string</BillToCity>
    <BillToState>string</BillToState>
    <BillToPostalCode>string</BillToPostalCode>
    <BillToCountryCode>string</BillToCountryCode>
    <BillToPhone>string</BillToPhone>
    <BillToEmail>string</BillToEmail>
    <ShipToName>string</ShipToName>
    <ShipToAddress1>string</ShipToAddress1>
    <ShipToAddress2>string</ShipToAddress2>
    <ShipToCity>string</ShipToCity>
    <ShipToState>string</ShipToState>
    <ShipToPostalCode>string</ShipToPostalCode>
    <ShipToCountryCode>string</ShipToCountryCode>
    <ShipToPhone>string</ShipToPhone>
    <ShipToEmail>string</ShipToEmail>
    <ShipFromName>string</ShipFromName>
    <ShipFromAddress1>string</ShipFromAddress1>
    <ShipFromAddress2>string</ShipFromAddress2>
    <ShipFromCity>string</ShipFromCity>
    <ShipFromState>string</ShipFromState>
    <ShipFromPostalCode>string</ShipFromPostalCode>
    <ShipFromCountryCode>string</ShipFromCountryCode>
    <ShipFromPhone>string</ShipFromPhone>
    <ShipFromEmail>string</ShipFromEmail>
    <ShippingCarrier>string</ShippingCarrier>
    <ShippingClass>None or Overnight or Two_Day or Three_Day or Ground or First_Class or Priority or Other</ShippingClass>
    <ShippingCosts>decimal</ShippingCosts>
    <ShippingHandlingCost>decimal</ShippingHandlingCost>
    <ShippingInsuranceCost>decimal</ShippingInsuranceCost>
    <IsOrderInsured>boolean</IsOrderInsured>
    <TrackingNumber>string</TrackingNumber>
    <FFLNumber>string</FFLNumber>
    <LostCashDiscount>decimal</LostCashDiscount>
    <OrderTotal>decimal</OrderTotal>
    <OrderItems>
      <OrderItemType>
        <ItemID>int</ItemID>
        <ItemTitle>string</ItemTitle>
        <ItemPrice>decimal</ItemPrice>
        <Quantity>int</Quantity>
        <SalesTax>decimal</SalesTax>
        <SalesTaxRate>decimal</SalesTaxRate>
        <ShippingProfileID>int</ShippingProfileID>
        <Weight>decimal</Weight>
        <WeightUnit>None or Pounds or Kilograms</WeightUnit>
        <ItemSubTotal>decimal</ItemSubTotal>
      </OrderItemType>
      <OrderItemType>
        <ItemID>int</ItemID>
        <ItemTitle>string</ItemTitle>
        <ItemPrice>decimal</ItemPrice>
        <Quantity>int</Quantity>
        <SalesTax>decimal</SalesTax>
        <SalesTaxRate>decimal</SalesTaxRate>
        <ShippingProfileID>int</ShippingProfileID>
        <Weight>decimal</Weight>
        <WeightUnit>None or Pounds or Kilograms</WeightUnit>
        <ItemSubTotal>decimal</ItemSubTotal>
      </OrderItemType>
    </OrderItems>
  </Order>
</OrderResponseType>