iSAMS Dispatch API


Click here for a complete list of operations.

ShipMultiParcelOrder

Ship order (to complete dispatch process) at the specified dispatch point.

Test

The test form is only available for methods with primitive types as parameters.

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 /global/api/Dispatch.asmx HTTP/1.1
Host: demo.viare.io
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.estaronline.com/api/dispatch/ShipMultiParcelOrder"

<?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>
    <ShipMultiParcelOrder xmlns="http://www.estaronline.com/api/dispatch">
      <authenticationToken>string</authenticationToken>
      <dispatchPointName>string</dispatchPointName>
      <orderID>int</orderID>
      <shippingReferences>
        <string>string</string>
        <string>string</string>
      </shippingReferences>
      <sendDispatchEmail>boolean</sendDispatchEmail>
    </ShipMultiParcelOrder>
  </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>
    <ShipMultiParcelOrderResponse xmlns="http://www.estaronline.com/api/dispatch">
      <ShipMultiParcelOrderResult>
        <Success>boolean</Success>
        <Code>int</Code>
        <Message>string</Message>
      </ShipMultiParcelOrderResult>
    </ShipMultiParcelOrderResponse>
  </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 /global/api/Dispatch.asmx HTTP/1.1
Host: demo.viare.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>
    <ShipMultiParcelOrder xmlns="http://www.estaronline.com/api/dispatch">
      <authenticationToken>string</authenticationToken>
      <dispatchPointName>string</dispatchPointName>
      <orderID>int</orderID>
      <shippingReferences>
        <string>string</string>
        <string>string</string>
      </shippingReferences>
      <sendDispatchEmail>boolean</sendDispatchEmail>
    </ShipMultiParcelOrder>
  </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>
    <ShipMultiParcelOrderResponse xmlns="http://www.estaronline.com/api/dispatch">
      <ShipMultiParcelOrderResult>
        <Success>boolean</Success>
        <Code>int</Code>
        <Message>string</Message>
      </ShipMultiParcelOrderResult>
    </ShipMultiParcelOrderResponse>
  </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 /global/api/Dispatch.asmx/ShipMultiParcelOrder?authenticationToken=string&dispatchPointName=string&orderID=string&shippingReferences=string&shippingReferences=string&sendDispatchEmail=string HTTP/1.1
Host: demo.viare.io

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

<?xml version="1.0" encoding="utf-8"?>
<ApiResponse xmlns="http://www.estaronline.com/api/dispatch">
  <Success>boolean</Success>
  <Code>int</Code>
  <Message>string</Message>
</ApiResponse>

HTTP POST

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

POST /global/api/Dispatch.asmx/ShipMultiParcelOrder HTTP/1.1
Host: demo.viare.io
Content-Type: application/x-www-form-urlencoded
Content-Length: length

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

<?xml version="1.0" encoding="utf-8"?>
<ApiResponse xmlns="http://www.estaronline.com/api/dispatch">
  <Success>boolean</Success>
  <Code>int</Code>
  <Message>string</Message>
</ApiResponse>