OrderService


Click here for a complete list of operations.

GetAmountToCapture

Retrieves the amount to be captured on an order. Can be filtered by supplier name and by specific items by providing part numbers and quantities requested.

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.
Parameter Value
ClientName:
Guid:
ExternalOrderID:
ProcessingOptions:
InboundXML:

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 /orderservice.asmx HTTP/1.1
Host: api-jako.aptos.io
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://api.shopvisible.com/GetAmountToCapture"

<?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>
    <GetAmountToCapture xmlns="http://api.shopvisible.com/">
      <ClientName>string</ClientName>
      <Guid>string</Guid>
      <ExternalOrderID>string</ExternalOrderID>
      <ProcessingOptions>string</ProcessingOptions>
      <InboundXML>string</InboundXML>
    </GetAmountToCapture>
  </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>
    <GetAmountToCaptureResponse xmlns="http://api.shopvisible.com/">
      <GetAmountToCaptureResult>xml</GetAmountToCaptureResult>
    </GetAmountToCaptureResponse>
  </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 /orderservice.asmx HTTP/1.1
Host: api-jako.aptos.io
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>
    <GetAmountToCapture xmlns="http://api.shopvisible.com/">
      <ClientName>string</ClientName>
      <Guid>string</Guid>
      <ExternalOrderID>string</ExternalOrderID>
      <ProcessingOptions>string</ProcessingOptions>
      <InboundXML>string</InboundXML>
    </GetAmountToCapture>
  </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>
    <GetAmountToCaptureResponse xmlns="http://api.shopvisible.com/">
      <GetAmountToCaptureResult>xml</GetAmountToCaptureResult>
    </GetAmountToCaptureResponse>
  </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 /orderservice.asmx/GetAmountToCapture?ClientName=string&Guid=string&ExternalOrderID=string&ProcessingOptions=string&InboundXML=string HTTP/1.1
Host: api-jako.aptos.io

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

<?xml version="1.0"?>
xml

HTTP POST

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

POST /orderservice.asmx/GetAmountToCapture HTTP/1.1
Host: api-jako.aptos.io
Content-Type: application/x-www-form-urlencoded
Content-Length: length

ClientName=string&Guid=string&ExternalOrderID=string&ProcessingOptions=string&InboundXML=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0"?>
xml