OrderService Web Service

OrderService

Click here for a complete list of operations.

ConfirmShippedOrderSOAP

Allows for an Order to be Ship Confirmed, and returns XML containing result information.

Test

The test form is only available for requests from the local machine.

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

<?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>
    <ConfirmShippedOrderSOAP xmlns="http://api.shopvisible.com/">
      <ClientName>string</ClientName>
      <Guid>string</Guid>
      <AdvanceShipNotices>
        <AdvanceShipNotice>
          <OrderID>string</OrderID>
          <CustomerName>string</CustomerName>
          <OrderShippingAddress1>string</OrderShippingAddress1>
          <ExternalOrderId>string</ExternalOrderId>
          <OrderShippingAddress2>string</OrderShippingAddress2>
          <OrderShippingCity>string</OrderShippingCity>
          <OrderShippingStateProvince>string</OrderShippingStateProvince>
          <OrderShippingZip>string</OrderShippingZip>
          <OrderShippingPhone>string</OrderShippingPhone>
          <CustomerEmail>string</CustomerEmail>
          <OrderShipDate>string</OrderShipDate>
          <LadingQuantity>string</LadingQuantity>
          <QuantitySent>string</QuantitySent>
          <OrderLevelTrackingNumber>string</OrderLevelTrackingNumber>
          <OrderLevelShipMethod>string</OrderLevelShipMethod>
          <Items>
            <Item xsi:nil="true" />
            <Item xsi:nil="true" />
          </Items>
          <Response>
            <ResponseHasErrors>boolean</ResponseHasErrors>
            <ResponseCode>string</ResponseCode>
            <ResponseDescription>string</ResponseDescription>
            <ResponseCustomReturn1>string</ResponseCustomReturn1>
            <ResponseCustomReturn2>string</ResponseCustomReturn2>
            <ResponseCustomReturn3>string</ResponseCustomReturn3>
            <ResponseCustomReturn4>string</ResponseCustomReturn4>
            <ResponseCustomReturn5>string</ResponseCustomReturn5>
            <ResponseDebugging>string</ResponseDebugging>
            <ResponseOrderSuccess xsi:nil="true" />
            <ResponseOrderErrors xsi:nil="true" />
            <ResponseOrderMessages xsi:nil="true" />
          </Response>
        </AdvanceShipNotice>
        <AdvanceShipNotice>
          <OrderID>string</OrderID>
          <CustomerName>string</CustomerName>
          <OrderShippingAddress1>string</OrderShippingAddress1>
          <ExternalOrderId>string</ExternalOrderId>
          <OrderShippingAddress2>string</OrderShippingAddress2>
          <OrderShippingCity>string</OrderShippingCity>
          <OrderShippingStateProvince>string</OrderShippingStateProvince>
          <OrderShippingZip>string</OrderShippingZip>
          <OrderShippingPhone>string</OrderShippingPhone>
          <CustomerEmail>string</CustomerEmail>
          <OrderShipDate>string</OrderShipDate>
          <LadingQuantity>string</LadingQuantity>
          <QuantitySent>string</QuantitySent>
          <OrderLevelTrackingNumber>string</OrderLevelTrackingNumber>
          <OrderLevelShipMethod>string</OrderLevelShipMethod>
          <Items>
            <Item xsi:nil="true" />
            <Item xsi:nil="true" />
          </Items>
          <Response>
            <ResponseHasErrors>boolean</ResponseHasErrors>
            <ResponseCode>string</ResponseCode>
            <ResponseDescription>string</ResponseDescription>
            <ResponseCustomReturn1>string</ResponseCustomReturn1>
            <ResponseCustomReturn2>string</ResponseCustomReturn2>
            <ResponseCustomReturn3>string</ResponseCustomReturn3>
            <ResponseCustomReturn4>string</ResponseCustomReturn4>
            <ResponseCustomReturn5>string</ResponseCustomReturn5>
            <ResponseDebugging>string</ResponseDebugging>
            <ResponseOrderSuccess xsi:nil="true" />
            <ResponseOrderErrors xsi:nil="true" />
            <ResponseOrderMessages xsi:nil="true" />
          </Response>
        </AdvanceShipNotice>
        <Response>
          <ResponseHasErrors>boolean</ResponseHasErrors>
          <ResponseCode>string</ResponseCode>
          <ResponseDescription>string</ResponseDescription>
          <ResponseCustomReturn1>string</ResponseCustomReturn1>
          <ResponseCustomReturn2>string</ResponseCustomReturn2>
          <ResponseCustomReturn3>string</ResponseCustomReturn3>
          <ResponseCustomReturn4>string</ResponseCustomReturn4>
          <ResponseCustomReturn5>string</ResponseCustomReturn5>
          <ResponseDebugging>string</ResponseDebugging>
          <ResponseOrderSuccess>
            <ResponseOrderSuccess xsi:nil="true" />
            <ResponseOrderSuccess xsi:nil="true" />
          </ResponseOrderSuccess>
          <ResponseOrderErrors>
            <ResponseOrderError xsi:nil="true" />
            <ResponseOrderError xsi:nil="true" />
          </ResponseOrderErrors>
          <ResponseOrderMessages>
            <ResponseOrderMessage xsi:nil="true" />
            <ResponseOrderMessage xsi:nil="true" />
          </ResponseOrderMessages>
        </Response>
      </AdvanceShipNotices>
      <CollectFunds>string</CollectFunds>
      <SendCustomerEmail>string</SendCustomerEmail>
      <CCCustomerEmail>string</CCCustomerEmail>
    </ConfirmShippedOrderSOAP>
  </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>
    <ConfirmShippedOrderSOAPResponse xmlns="http://api.shopvisible.com/">
      <ConfirmShippedOrderSOAPResult>xml</ConfirmShippedOrderSOAPResult>
    </ConfirmShippedOrderSOAPResponse>
  </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>
    <ConfirmShippedOrderSOAP xmlns="http://api.shopvisible.com/">
      <ClientName>string</ClientName>
      <Guid>string</Guid>
      <AdvanceShipNotices>
        <AdvanceShipNotice>
          <OrderID>string</OrderID>
          <CustomerName>string</CustomerName>
          <OrderShippingAddress1>string</OrderShippingAddress1>
          <ExternalOrderId>string</ExternalOrderId>
          <OrderShippingAddress2>string</OrderShippingAddress2>
          <OrderShippingCity>string</OrderShippingCity>
          <OrderShippingStateProvince>string</OrderShippingStateProvince>
          <OrderShippingZip>string</OrderShippingZip>
          <OrderShippingPhone>string</OrderShippingPhone>
          <CustomerEmail>string</CustomerEmail>
          <OrderShipDate>string</OrderShipDate>
          <LadingQuantity>string</LadingQuantity>
          <QuantitySent>string</QuantitySent>
          <OrderLevelTrackingNumber>string</OrderLevelTrackingNumber>
          <OrderLevelShipMethod>string</OrderLevelShipMethod>
          <Items>
            <Item xsi:nil="true" />
            <Item xsi:nil="true" />
          </Items>
          <Response>
            <ResponseHasErrors>boolean</ResponseHasErrors>
            <ResponseCode>string</ResponseCode>
            <ResponseDescription>string</ResponseDescription>
            <ResponseCustomReturn1>string</ResponseCustomReturn1>
            <ResponseCustomReturn2>string</ResponseCustomReturn2>
            <ResponseCustomReturn3>string</ResponseCustomReturn3>
            <ResponseCustomReturn4>string</ResponseCustomReturn4>
            <ResponseCustomReturn5>string</ResponseCustomReturn5>
            <ResponseDebugging>string</ResponseDebugging>
            <ResponseOrderSuccess xsi:nil="true" />
            <ResponseOrderErrors xsi:nil="true" />
            <ResponseOrderMessages xsi:nil="true" />
          </Response>
        </AdvanceShipNotice>
        <AdvanceShipNotice>
          <OrderID>string</OrderID>
          <CustomerName>string</CustomerName>
          <OrderShippingAddress1>string</OrderShippingAddress1>
          <ExternalOrderId>string</ExternalOrderId>
          <OrderShippingAddress2>string</OrderShippingAddress2>
          <OrderShippingCity>string</OrderShippingCity>
          <OrderShippingStateProvince>string</OrderShippingStateProvince>
          <OrderShippingZip>string</OrderShippingZip>
          <OrderShippingPhone>string</OrderShippingPhone>
          <CustomerEmail>string</CustomerEmail>
          <OrderShipDate>string</OrderShipDate>
          <LadingQuantity>string</LadingQuantity>
          <QuantitySent>string</QuantitySent>
          <OrderLevelTrackingNumber>string</OrderLevelTrackingNumber>
          <OrderLevelShipMethod>string</OrderLevelShipMethod>
          <Items>
            <Item xsi:nil="true" />
            <Item xsi:nil="true" />
          </Items>
          <Response>
            <ResponseHasErrors>boolean</ResponseHasErrors>
            <ResponseCode>string</ResponseCode>
            <ResponseDescription>string</ResponseDescription>
            <ResponseCustomReturn1>string</ResponseCustomReturn1>
            <ResponseCustomReturn2>string</ResponseCustomReturn2>
            <ResponseCustomReturn3>string</ResponseCustomReturn3>
            <ResponseCustomReturn4>string</ResponseCustomReturn4>
            <ResponseCustomReturn5>string</ResponseCustomReturn5>
            <ResponseDebugging>string</ResponseDebugging>
            <ResponseOrderSuccess xsi:nil="true" />
            <ResponseOrderErrors xsi:nil="true" />
            <ResponseOrderMessages xsi:nil="true" />
          </Response>
        </AdvanceShipNotice>
        <Response>
          <ResponseHasErrors>boolean</ResponseHasErrors>
          <ResponseCode>string</ResponseCode>
          <ResponseDescription>string</ResponseDescription>
          <ResponseCustomReturn1>string</ResponseCustomReturn1>
          <ResponseCustomReturn2>string</ResponseCustomReturn2>
          <ResponseCustomReturn3>string</ResponseCustomReturn3>
          <ResponseCustomReturn4>string</ResponseCustomReturn4>
          <ResponseCustomReturn5>string</ResponseCustomReturn5>
          <ResponseDebugging>string</ResponseDebugging>
          <ResponseOrderSuccess>
            <ResponseOrderSuccess xsi:nil="true" />
            <ResponseOrderSuccess xsi:nil="true" />
          </ResponseOrderSuccess>
          <ResponseOrderErrors>
            <ResponseOrderError xsi:nil="true" />
            <ResponseOrderError xsi:nil="true" />
          </ResponseOrderErrors>
          <ResponseOrderMessages>
            <ResponseOrderMessage xsi:nil="true" />
            <ResponseOrderMessage xsi:nil="true" />
          </ResponseOrderMessages>
        </Response>
      </AdvanceShipNotices>
      <CollectFunds>string</CollectFunds>
      <SendCustomerEmail>string</SendCustomerEmail>
      <CCCustomerEmail>string</CCCustomerEmail>
    </ConfirmShippedOrderSOAP>
  </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>
    <ConfirmShippedOrderSOAPResponse xmlns="http://api.shopvisible.com/">
      <ConfirmShippedOrderSOAPResult>xml</ConfirmShippedOrderSOAPResult>
    </ConfirmShippedOrderSOAPResponse>
  </soap12:Body>
</soap12:Envelope>