iSAMS Orders API Web Service

iSAMS Orders API

Click here for a complete list of operations.

RecordReturnedItem

Records the return of the specified quantity of the order item and mark as 'deleted' in iSAMS

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

<?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>
    <RecordReturnedItem xmlns="http://www.estaronline.com/api/orders">
      <authenticationToken>string</authenticationToken>
      <item>
        <OrderItemID xmlns="http://www.estaronline.com/api">int</OrderItemID>
        <QuantityReturned xmlns="http://www.estaronline.com/api">int</QuantityReturned>
        <ReasonCode xmlns="http://www.estaronline.com/api">string</ReasonCode>
        <ReasonDescription xmlns="http://www.estaronline.com/api">string</ReasonDescription>
      </item>
    </RecordReturnedItem>
  </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>
    <RecordReturnedItemResponse xmlns="http://www.estaronline.com/api/orders">
      <RecordReturnedItemResult>
        <Success>boolean</Success>
        <Code>int</Code>
        <Message>string</Message>
      </RecordReturnedItemResult>
    </RecordReturnedItemResponse>
  </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>
    <RecordReturnedItem xmlns="http://www.estaronline.com/api/orders">
      <authenticationToken>string</authenticationToken>
      <item>
        <OrderItemID xmlns="http://www.estaronline.com/api">int</OrderItemID>
        <QuantityReturned xmlns="http://www.estaronline.com/api">int</QuantityReturned>
        <ReasonCode xmlns="http://www.estaronline.com/api">string</ReasonCode>
        <ReasonDescription xmlns="http://www.estaronline.com/api">string</ReasonDescription>
      </item>
    </RecordReturnedItem>
  </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>
    <RecordReturnedItemResponse xmlns="http://www.estaronline.com/api/orders">
      <RecordReturnedItemResult>
        <Success>boolean</Success>
        <Code>int</Code>
        <Message>string</Message>
      </RecordReturnedItemResult>
    </RecordReturnedItemResponse>
  </soap12:Body>
</soap12:Envelope>