iSAMS Sales and Returns API Web Service

iSAMS Sales and Returns API

Click here for a complete list of operations.

RetrieveReturn

Retrieves the specified return.

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/SalesReturns.asmx HTTP/1.1
Host: demo.viare.io
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.estaronline.com/api/SaleReturn/RetrieveReturn"

<?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>
    <RetrieveReturn xmlns="http://www.estaronline.com/api/SaleReturn">
      <authenticationToken>string</authenticationToken>
      <returnID>int</returnID>
    </RetrieveReturn>
  </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>
    <RetrieveReturnResponse xmlns="http://www.estaronline.com/api/SaleReturn">
      <RetrieveReturnResult>
        <Data>
          <Sale>
            <ExportID>int</ExportID>
            <OrderID>int</OrderID>
            <ReturnID>int</ReturnID>
            <WebsiteID>int</WebsiteID>
            <DisplayStateName>string</DisplayStateName>
            <Type>string</Type>
            <OrderDate>dateTime</OrderDate>
            <DispatchDate>dateTime</DispatchDate>
            <Currency>string</Currency>
            <CustomerID>int</CustomerID>
            <CustomerForeignID>string</CustomerForeignID>
            <Addresses xsi:nil="true" />
            <OrderDiscount>decimal</OrderDiscount>
            <SaleItems xsi:nil="true" />
            <Payments xsi:nil="true" />
          </Sale>
          <Sale>
            <ExportID>int</ExportID>
            <OrderID>int</OrderID>
            <ReturnID>int</ReturnID>
            <WebsiteID>int</WebsiteID>
            <DisplayStateName>string</DisplayStateName>
            <Type>string</Type>
            <OrderDate>dateTime</OrderDate>
            <DispatchDate>dateTime</DispatchDate>
            <Currency>string</Currency>
            <CustomerID>int</CustomerID>
            <CustomerForeignID>string</CustomerForeignID>
            <Addresses xsi:nil="true" />
            <OrderDiscount>decimal</OrderDiscount>
            <SaleItems xsi:nil="true" />
            <Payments xsi:nil="true" />
          </Sale>
        </Data>
      </RetrieveReturnResult>
    </RetrieveReturnResponse>
  </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/SalesReturns.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>
    <RetrieveReturn xmlns="http://www.estaronline.com/api/SaleReturn">
      <authenticationToken>string</authenticationToken>
      <returnID>int</returnID>
    </RetrieveReturn>
  </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>
    <RetrieveReturnResponse xmlns="http://www.estaronline.com/api/SaleReturn">
      <RetrieveReturnResult>
        <Data>
          <Sale>
            <ExportID>int</ExportID>
            <OrderID>int</OrderID>
            <ReturnID>int</ReturnID>
            <WebsiteID>int</WebsiteID>
            <DisplayStateName>string</DisplayStateName>
            <Type>string</Type>
            <OrderDate>dateTime</OrderDate>
            <DispatchDate>dateTime</DispatchDate>
            <Currency>string</Currency>
            <CustomerID>int</CustomerID>
            <CustomerForeignID>string</CustomerForeignID>
            <Addresses xsi:nil="true" />
            <OrderDiscount>decimal</OrderDiscount>
            <SaleItems xsi:nil="true" />
            <Payments xsi:nil="true" />
          </Sale>
          <Sale>
            <ExportID>int</ExportID>
            <OrderID>int</OrderID>
            <ReturnID>int</ReturnID>
            <WebsiteID>int</WebsiteID>
            <DisplayStateName>string</DisplayStateName>
            <Type>string</Type>
            <OrderDate>dateTime</OrderDate>
            <DispatchDate>dateTime</DispatchDate>
            <Currency>string</Currency>
            <CustomerID>int</CustomerID>
            <CustomerForeignID>string</CustomerForeignID>
            <Addresses xsi:nil="true" />
            <OrderDiscount>decimal</OrderDiscount>
            <SaleItems xsi:nil="true" />
            <Payments xsi:nil="true" />
          </Sale>
        </Data>
      </RetrieveReturnResult>
    </RetrieveReturnResponse>
  </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/SalesReturns.asmx/RetrieveReturn?authenticationToken=string&returnID=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"?>
<SaleReturnApiResponse xmlns="http://www.estaronline.com/api/SaleReturn">
  <Data>
    <Sale>
      <ExportID>int</ExportID>
      <OrderID>int</OrderID>
      <ReturnID>int</ReturnID>
      <WebsiteID>int</WebsiteID>
      <DisplayStateName>string</DisplayStateName>
      <Type>string</Type>
      <OrderDate>dateTime</OrderDate>
      <DispatchDate>dateTime</DispatchDate>
      <Currency>string</Currency>
      <CustomerID>int</CustomerID>
      <CustomerForeignID>string</CustomerForeignID>
      <Addresses>
        <CustomerAddress d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <CustomerAddress d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Addresses>
      <OrderDiscount>decimal</OrderDiscount>
      <SaleItems>
        <SaleItem d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <SaleItem d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </SaleItems>
      <Payments>
        <Payment d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <Payment d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Payments>
    </Sale>
    <Sale>
      <ExportID>int</ExportID>
      <OrderID>int</OrderID>
      <ReturnID>int</ReturnID>
      <WebsiteID>int</WebsiteID>
      <DisplayStateName>string</DisplayStateName>
      <Type>string</Type>
      <OrderDate>dateTime</OrderDate>
      <DispatchDate>dateTime</DispatchDate>
      <Currency>string</Currency>
      <CustomerID>int</CustomerID>
      <CustomerForeignID>string</CustomerForeignID>
      <Addresses>
        <CustomerAddress d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <CustomerAddress d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Addresses>
      <OrderDiscount>decimal</OrderDiscount>
      <SaleItems>
        <SaleItem d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <SaleItem d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </SaleItems>
      <Payments>
        <Payment d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <Payment d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Payments>
    </Sale>
  </Data>
</SaleReturnApiResponse>

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/SalesReturns.asmx/RetrieveReturn HTTP/1.1
Host: demo.viare.io
Content-Type: application/x-www-form-urlencoded
Content-Length: length

authenticationToken=string&returnID=string

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<SaleReturnApiResponse xmlns="http://www.estaronline.com/api/SaleReturn">
  <Data>
    <Sale>
      <ExportID>int</ExportID>
      <OrderID>int</OrderID>
      <ReturnID>int</ReturnID>
      <WebsiteID>int</WebsiteID>
      <DisplayStateName>string</DisplayStateName>
      <Type>string</Type>
      <OrderDate>dateTime</OrderDate>
      <DispatchDate>dateTime</DispatchDate>
      <Currency>string</Currency>
      <CustomerID>int</CustomerID>
      <CustomerForeignID>string</CustomerForeignID>
      <Addresses>
        <CustomerAddress d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <CustomerAddress d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Addresses>
      <OrderDiscount>decimal</OrderDiscount>
      <SaleItems>
        <SaleItem d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <SaleItem d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </SaleItems>
      <Payments>
        <Payment d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <Payment d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Payments>
    </Sale>
    <Sale>
      <ExportID>int</ExportID>
      <OrderID>int</OrderID>
      <ReturnID>int</ReturnID>
      <WebsiteID>int</WebsiteID>
      <DisplayStateName>string</DisplayStateName>
      <Type>string</Type>
      <OrderDate>dateTime</OrderDate>
      <DispatchDate>dateTime</DispatchDate>
      <Currency>string</Currency>
      <CustomerID>int</CustomerID>
      <CustomerForeignID>string</CustomerForeignID>
      <Addresses>
        <CustomerAddress d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <CustomerAddress d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Addresses>
      <OrderDiscount>decimal</OrderDiscount>
      <SaleItems>
        <SaleItem d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <SaleItem d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </SaleItems>
      <Payments>
        <Payment d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <Payment d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Payments>
    </Sale>
  </Data>
</SaleReturnApiResponse>

Parameter	Value
authenticationToken:
returnID: