iSAMS Orders API
Click here for a complete list of operations.
VoidOrder
Voids an order. An order can be voided at any 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/VoidOrder"
<?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>
<VoidOrder xmlns="http://www.estaronline.com/api/orders">
<authenticationToken>string</authenticationToken>
<orderID>int</orderID>
<voidReasonCode>string</voidReasonCode>
</VoidOrder>
</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>
<VoidOrderResponse xmlns="http://www.estaronline.com/api/orders">
<VoidOrderResult>
<Success>boolean</Success>
<Code>int</Code>
<Message>string</Message>
</VoidOrderResult>
</VoidOrderResponse>
</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>
<VoidOrder xmlns="http://www.estaronline.com/api/orders">
<authenticationToken>string</authenticationToken>
<orderID>int</orderID>
<voidReasonCode>string</voidReasonCode>
</VoidOrder>
</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>
<VoidOrderResponse xmlns="http://www.estaronline.com/api/orders">
<VoidOrderResult>
<Success>boolean</Success>
<Code>int</Code>
<Message>string</Message>
</VoidOrderResult>
</VoidOrderResponse>
</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/VoidOrder?authenticationToken=string&orderID=string&voidReasonCode=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/orders"> <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/Orders.asmx/VoidOrder HTTP/1.1 Host: demo.viare.io Content-Type: application/x-www-form-urlencoded Content-Length: length authenticationToken=string&orderID=string&voidReasonCode=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/orders"> <Success>boolean</Success> <Code>int</Code> <Message>string</Message> </ApiResponse>