iSAMS Dispatch API


Click here for a complete list of operations.

ShipTrackedOrder

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

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

<?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>
    <ShipTrackedOrder xmlns="http://www.estaronline.com/api/dispatch">
      <authenticationToken>string</authenticationToken>
      <dispatchPointName>string</dispatchPointName>
      <orderID>int</orderID>
      <trackingDetails>
        <TrackingDetail>
          <TrackingReference>string</TrackingReference>
          <TrackingURL>string</TrackingURL>
          <CarrierName>string</CarrierName>
        </TrackingDetail>
        <TrackingDetail>
          <TrackingReference>string</TrackingReference>
          <TrackingURL>string</TrackingURL>
          <CarrierName>string</CarrierName>
        </TrackingDetail>
      </trackingDetails>
      <sendDispatchEmail>boolean</sendDispatchEmail>
    </ShipTrackedOrder>
  </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>
    <ShipTrackedOrderResponse xmlns="http://www.estaronline.com/api/dispatch">
      <ShipTrackedOrderResult>
        <Success>boolean</Success>
        <Code>int</Code>
        <Message>string</Message>
      </ShipTrackedOrderResult>
    </ShipTrackedOrderResponse>
  </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>
    <ShipTrackedOrder xmlns="http://www.estaronline.com/api/dispatch">
      <authenticationToken>string</authenticationToken>
      <dispatchPointName>string</dispatchPointName>
      <orderID>int</orderID>
      <trackingDetails>
        <TrackingDetail>
          <TrackingReference>string</TrackingReference>
          <TrackingURL>string</TrackingURL>
          <CarrierName>string</CarrierName>
        </TrackingDetail>
        <TrackingDetail>
          <TrackingReference>string</TrackingReference>
          <TrackingURL>string</TrackingURL>
          <CarrierName>string</CarrierName>
        </TrackingDetail>
      </trackingDetails>
      <sendDispatchEmail>boolean</sendDispatchEmail>
    </ShipTrackedOrder>
  </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>
    <ShipTrackedOrderResponse xmlns="http://www.estaronline.com/api/dispatch">
      <ShipTrackedOrderResult>
        <Success>boolean</Success>
        <Code>int</Code>
        <Message>string</Message>
      </ShipTrackedOrderResult>
    </ShipTrackedOrderResponse>
  </soap12:Body>
</soap12:Envelope>