iSAMS Dispatch API
Click here for a complete list of operations.
ListOrdersToShip
Lists all orders ready for shipping in dispatch point.
Test
To test the operation using the HTTP POST protocol, click the 'Invoke' button.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/ListOrdersToShip"
<?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>
<ListOrdersToShip xmlns="http://www.estaronline.com/api/dispatch">
<authenticationToken>string</authenticationToken>
<dispatchPointName>string</dispatchPointName>
</ListOrdersToShip>
</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>
<ListOrdersToShipResponse xmlns="http://www.estaronline.com/api/dispatch">
<ListOrdersToShipResult>
<Data>
<int>int</int>
<int>int</int>
</Data>
</ListOrdersToShipResult>
</ListOrdersToShipResponse>
</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>
<ListOrdersToShip xmlns="http://www.estaronline.com/api/dispatch">
<authenticationToken>string</authenticationToken>
<dispatchPointName>string</dispatchPointName>
</ListOrdersToShip>
</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>
<ListOrdersToShipResponse xmlns="http://www.estaronline.com/api/dispatch">
<ListOrdersToShipResult>
<Data>
<int>int</int>
<int>int</int>
</Data>
</ListOrdersToShipResult>
</ListOrdersToShipResponse>
</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/ListOrdersToShip?authenticationToken=string&dispatchPointName=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"?>
<IntegerArrayApiResponse xmlns="http://www.estaronline.com/api/dispatch">
<Data>
<int>int</int>
<int>int</int>
</Data>
</IntegerArrayApiResponse>
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/ListOrdersToShip HTTP/1.1 Host: demo.viare.io Content-Type: application/x-www-form-urlencoded Content-Length: length authenticationToken=string&dispatchPointName=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<IntegerArrayApiResponse xmlns="http://www.estaronline.com/api/dispatch">
<Data>
<int>int</int>
<int>int</int>
</Data>
</IntegerArrayApiResponse>