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.

MarkOrderPaymentReceived

Marks the payment on an order as received

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

<?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>
    <MarkOrderPaymentReceived xmlns="GunBrokerAPI_V2">
      <orderID>int</orderID>
    </MarkOrderPaymentReceived>
  </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>
    <MarkOrderPaymentReceivedResponse xmlns="GunBrokerAPI_V2">
      <MarkOrderPaymentReceivedResponseType>
        <Timestamp>dateTime</Timestamp>
        <Ack>Success or Failure or Warning</Ack>
        <Errors>
          <ShortMessage>string</ShortMessage>
          <LongMessage>string</LongMessage>
          <ErrorCode>string</ErrorCode>
        </Errors>
      </MarkOrderPaymentReceivedResponseType>
    </MarkOrderPaymentReceivedResponse>
  </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>
    <MarkOrderPaymentReceived xmlns="GunBrokerAPI_V2">
      <orderID>int</orderID>
    </MarkOrderPaymentReceived>
  </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>
    <MarkOrderPaymentReceivedResponse xmlns="GunBrokerAPI_V2">
      <MarkOrderPaymentReceivedResponseType>
        <Timestamp>dateTime</Timestamp>
        <Ack>Success or Failure or Warning</Ack>
        <Errors>
          <ShortMessage>string</ShortMessage>
          <LongMessage>string</LongMessage>
          <ErrorCode>string</ErrorCode>
        </Errors>
      </MarkOrderPaymentReceivedResponseType>
    </MarkOrderPaymentReceivedResponse>
  </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/MarkOrderPaymentReceived?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"?>
<MarkOrderPaymentReceivedResponseType xmlns="GunBrokerAPI_V2">
  <Timestamp>dateTime</Timestamp>
  <Ack>Success or Failure or Warning</Ack>
  <Errors>
    <ShortMessage>string</ShortMessage>
    <LongMessage>string</LongMessage>
    <ErrorCode>string</ErrorCode>
  </Errors>
</MarkOrderPaymentReceivedResponseType>

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/MarkOrderPaymentReceived 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"?>
<MarkOrderPaymentReceivedResponseType xmlns="GunBrokerAPI_V2">
  <Timestamp>dateTime</Timestamp>
  <Ack>Success or Failure or Warning</Ack>
  <Errors>
    <ShortMessage>string</ShortMessage>
    <LongMessage>string</LongMessage>
    <ErrorCode>string</ErrorCode>
  </Errors>
</MarkOrderPaymentReceivedResponseType>