OrderService


Click here for a complete list of operations.

SubmitOrderNoteSOAP

Submits an order note for a specified order id.

Test

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

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

<?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>
    <SubmitOrderNoteSOAP xmlns="http://api.shopvisible.com/">
      <ClientName>string</ClientName>
      <Guid>string</Guid>
      <OrderID>string</OrderID>
      <OrderNote>string</OrderNote>
      <ProcessingOptions>string</ProcessingOptions>
    </SubmitOrderNoteSOAP>
  </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>
    <SubmitOrderNoteSOAPResponse xmlns="http://api.shopvisible.com/">
      <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>
            <OrderID>string</OrderID>
            <OrderStatusID>string</OrderStatusID>
            <OrderCustomerID>string</OrderCustomerID>
            <OrderInfo>string</OrderInfo>
          </ResponseOrderSuccess>
          <ResponseOrderSuccess>
            <OrderID>string</OrderID>
            <OrderStatusID>string</OrderStatusID>
            <OrderCustomerID>string</OrderCustomerID>
            <OrderInfo>string</OrderInfo>
          </ResponseOrderSuccess>
        </ResponseOrderSuccess>
        <ResponseOrderErrors>
          <ResponseOrderError>
            <OrderInfo>string</OrderInfo>
            <OrderErrors xsi:nil="true" />
          </ResponseOrderError>
          <ResponseOrderError>
            <OrderInfo>string</OrderInfo>
            <OrderErrors xsi:nil="true" />
          </ResponseOrderError>
        </ResponseOrderErrors>
        <ResponseOrderMessages>
          <ResponseOrderMessage>
            <OrderInfo>string</OrderInfo>
            <OrderMessages xsi:nil="true" />
          </ResponseOrderMessage>
          <ResponseOrderMessage>
            <OrderInfo>string</OrderInfo>
            <OrderMessages xsi:nil="true" />
          </ResponseOrderMessage>
        </ResponseOrderMessages>
      </Response>
    </SubmitOrderNoteSOAPResponse>
  </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>
    <SubmitOrderNoteSOAP xmlns="http://api.shopvisible.com/">
      <ClientName>string</ClientName>
      <Guid>string</Guid>
      <OrderID>string</OrderID>
      <OrderNote>string</OrderNote>
      <ProcessingOptions>string</ProcessingOptions>
    </SubmitOrderNoteSOAP>
  </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>
    <SubmitOrderNoteSOAPResponse xmlns="http://api.shopvisible.com/">
      <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>
            <OrderID>string</OrderID>
            <OrderStatusID>string</OrderStatusID>
            <OrderCustomerID>string</OrderCustomerID>
            <OrderInfo>string</OrderInfo>
          </ResponseOrderSuccess>
          <ResponseOrderSuccess>
            <OrderID>string</OrderID>
            <OrderStatusID>string</OrderStatusID>
            <OrderCustomerID>string</OrderCustomerID>
            <OrderInfo>string</OrderInfo>
          </ResponseOrderSuccess>
        </ResponseOrderSuccess>
        <ResponseOrderErrors>
          <ResponseOrderError>
            <OrderInfo>string</OrderInfo>
            <OrderErrors xsi:nil="true" />
          </ResponseOrderError>
          <ResponseOrderError>
            <OrderInfo>string</OrderInfo>
            <OrderErrors xsi:nil="true" />
          </ResponseOrderError>
        </ResponseOrderErrors>
        <ResponseOrderMessages>
          <ResponseOrderMessage>
            <OrderInfo>string</OrderInfo>
            <OrderMessages xsi:nil="true" />
          </ResponseOrderMessage>
          <ResponseOrderMessage>
            <OrderInfo>string</OrderInfo>
            <OrderMessages xsi:nil="true" />
          </ResponseOrderMessage>
        </ResponseOrderMessages>
      </Response>
    </SubmitOrderNoteSOAPResponse>
  </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/SubmitOrderNoteSOAP?ClientName=string&Guid=string&OrderID=string&OrderNote=string&ProcessingOptions=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" encoding="utf-8"?>
<Response xmlns="http://api.shopvisible.com/">
  <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>
      <OrderID>string</OrderID>
      <OrderStatusID>string</OrderStatusID>
      <OrderCustomerID>string</OrderCustomerID>
      <OrderInfo>string</OrderInfo>
    </ResponseOrderSuccess>
    <ResponseOrderSuccess>
      <OrderID>string</OrderID>
      <OrderStatusID>string</OrderStatusID>
      <OrderCustomerID>string</OrderCustomerID>
      <OrderInfo>string</OrderInfo>
    </ResponseOrderSuccess>
  </ResponseOrderSuccess>
  <ResponseOrderErrors>
    <ResponseOrderError>
      <OrderInfo>string</OrderInfo>
      <OrderErrors>
        <ErrorDetail>string</ErrorDetail>
        <ErrorDetail>string</ErrorDetail>
      </OrderErrors>
    </ResponseOrderError>
    <ResponseOrderError>
      <OrderInfo>string</OrderInfo>
      <OrderErrors>
        <ErrorDetail>string</ErrorDetail>
        <ErrorDetail>string</ErrorDetail>
      </OrderErrors>
    </ResponseOrderError>
  </ResponseOrderErrors>
  <ResponseOrderMessages>
    <ResponseOrderMessage>
      <OrderInfo>string</OrderInfo>
      <OrderMessages>
        <MessageDetail>string</MessageDetail>
        <MessageDetail>string</MessageDetail>
      </OrderMessages>
    </ResponseOrderMessage>
    <ResponseOrderMessage>
      <OrderInfo>string</OrderInfo>
      <OrderMessages>
        <MessageDetail>string</MessageDetail>
        <MessageDetail>string</MessageDetail>
      </OrderMessages>
    </ResponseOrderMessage>
  </ResponseOrderMessages>
</Response>

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/SubmitOrderNoteSOAP HTTP/1.1
Host: api-jako.aptos.io
Content-Type: application/x-www-form-urlencoded
Content-Length: length

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

<?xml version="1.0" encoding="utf-8"?>
<Response xmlns="http://api.shopvisible.com/">
  <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>
      <OrderID>string</OrderID>
      <OrderStatusID>string</OrderStatusID>
      <OrderCustomerID>string</OrderCustomerID>
      <OrderInfo>string</OrderInfo>
    </ResponseOrderSuccess>
    <ResponseOrderSuccess>
      <OrderID>string</OrderID>
      <OrderStatusID>string</OrderStatusID>
      <OrderCustomerID>string</OrderCustomerID>
      <OrderInfo>string</OrderInfo>
    </ResponseOrderSuccess>
  </ResponseOrderSuccess>
  <ResponseOrderErrors>
    <ResponseOrderError>
      <OrderInfo>string</OrderInfo>
      <OrderErrors>
        <ErrorDetail>string</ErrorDetail>
        <ErrorDetail>string</ErrorDetail>
      </OrderErrors>
    </ResponseOrderError>
    <ResponseOrderError>
      <OrderInfo>string</OrderInfo>
      <OrderErrors>
        <ErrorDetail>string</ErrorDetail>
        <ErrorDetail>string</ErrorDetail>
      </OrderErrors>
    </ResponseOrderError>
  </ResponseOrderErrors>
  <ResponseOrderMessages>
    <ResponseOrderMessage>
      <OrderInfo>string</OrderInfo>
      <OrderMessages>
        <MessageDetail>string</MessageDetail>
        <MessageDetail>string</MessageDetail>
      </OrderMessages>
    </ResponseOrderMessage>
    <ResponseOrderMessage>
      <OrderInfo>string</OrderInfo>
      <OrderMessages>
        <MessageDetail>string</MessageDetail>
        <MessageDetail>string</MessageDetail>
      </OrderMessages>
    </ResponseOrderMessage>
  </ResponseOrderMessages>
</Response>