iSAMS Orders API
Click here for a complete list of operations.
ListByStatus
Search for orders matching the specified order status.
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/Orders.asmx HTTP/1.1
Host: demo.viare.io
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.estaronline.com/api/orders/ListByStatus"
<?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>
<ListByStatus xmlns="http://www.estaronline.com/api/orders">
<authenticationToken>string</authenticationToken>
<status>Initiated or Confirmed or InProgress or InvalidCardNumber or Completed or Cancelled or PaymentProcessing or PaymentProcessingError or ToBePrinted or ReadyToDispatch or PersonaliseItems or PendingPaymentProcessing or ExportedToExternal or ShippedToStore or ReceivedInStore or PendingRiskEvaluation or PotentiallyFraudulent or FraudulentOrder or PendingManualPayment or SendInProgress3PL or DispatchInProgress3PL or SendError3PL or UpdateError3PL or OrderSubmitting or ProcessingMOTO or Unknown</status>
</ListByStatus>
</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>
<ListByStatusResponse xmlns="http://www.estaronline.com/api/orders">
<ListByStatusResult>
<Data>
<int>int</int>
<int>int</int>
</Data>
</ListByStatusResult>
</ListByStatusResponse>
</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/Orders.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>
<ListByStatus xmlns="http://www.estaronline.com/api/orders">
<authenticationToken>string</authenticationToken>
<status>Initiated or Confirmed or InProgress or InvalidCardNumber or Completed or Cancelled or PaymentProcessing or PaymentProcessingError or ToBePrinted or ReadyToDispatch or PersonaliseItems or PendingPaymentProcessing or ExportedToExternal or ShippedToStore or ReceivedInStore or PendingRiskEvaluation or PotentiallyFraudulent or FraudulentOrder or PendingManualPayment or SendInProgress3PL or DispatchInProgress3PL or SendError3PL or UpdateError3PL or OrderSubmitting or ProcessingMOTO or Unknown</status>
</ListByStatus>
</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>
<ListByStatusResponse xmlns="http://www.estaronline.com/api/orders">
<ListByStatusResult>
<Data>
<int>int</int>
<int>int</int>
</Data>
</ListByStatusResult>
</ListByStatusResponse>
</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/Orders.asmx/ListByStatus?authenticationToken=string&status=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/orders">
<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/Orders.asmx/ListByStatus HTTP/1.1 Host: demo.viare.io Content-Type: application/x-www-form-urlencoded Content-Length: length authenticationToken=string&status=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/orders">
<Data>
<int>int</int>
<int>int</int>
</Data>
</IntegerArrayApiResponse>