iSAMS Products API Web Service

iSAMS Products API

Click here for a complete list of operations.

RetrieveSetByWebsite

Retrieves a set of specified products.

Test

The test form is only available for methods with primitive types as parameters.

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

<?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>
    <RetrieveSetByWebsite xmlns="http://www.estaronline.com/api/">
      <authenticationToken>string</authenticationToken>
      <styles>
        <string>string</string>
        <string>string</string>
      </styles>
      <website>int</website>
    </RetrieveSetByWebsite>
  </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>
    <RetrieveSetByWebsiteResponse xmlns="http://www.estaronline.com/api/">
      <RetrieveSetByWebsiteResult>
        <Data>
          <Product>
            <ID>int</ID>
            <Title>string</Title>
            <ShortDescription>string</ShortDescription>
            <LongDescription>string</LongDescription>
            <Supplier>string</Supplier>
            <Style>string</Style>
            <Status>int</Status>
            <AvailableFrom>dateTime</AvailableFrom>
            <Price>decimal</Price>
            <Cost>decimal</Cost>
            <ContentLocked>boolean</ContentLocked>
            <ForeignIdentity>string</ForeignIdentity>
            <Weight>double</Weight>
            <Manufacturer>string</Manufacturer>
            <DateCreated>dateTime</DateCreated>
            <Items xsi:nil="true" />
            <ProductCompositeType>Product or Group or Set</ProductCompositeType>
            <CompositeChildren xsi:nil="true" />
            <Catalogues xsi:nil="true" />
            <Aspects xsi:nil="true" />
            <ProductAspects xsi:nil="true" />
            <Metadata xsi:nil="true" />
            <Images xsi:nil="true" />
            <AdditionalDetails>string</AdditionalDetails>
            <ProductInformation xsi:nil="true" />
            <ProductType>string</ProductType>
            <RiskCategory>string</RiskCategory>
          </Product>
          <Product>
            <ID>int</ID>
            <Title>string</Title>
            <ShortDescription>string</ShortDescription>
            <LongDescription>string</LongDescription>
            <Supplier>string</Supplier>
            <Style>string</Style>
            <Status>int</Status>
            <AvailableFrom>dateTime</AvailableFrom>
            <Price>decimal</Price>
            <Cost>decimal</Cost>
            <ContentLocked>boolean</ContentLocked>
            <ForeignIdentity>string</ForeignIdentity>
            <Weight>double</Weight>
            <Manufacturer>string</Manufacturer>
            <DateCreated>dateTime</DateCreated>
            <Items xsi:nil="true" />
            <ProductCompositeType>Product or Group or Set</ProductCompositeType>
            <CompositeChildren xsi:nil="true" />
            <Catalogues xsi:nil="true" />
            <Aspects xsi:nil="true" />
            <ProductAspects xsi:nil="true" />
            <Metadata xsi:nil="true" />
            <Images xsi:nil="true" />
            <AdditionalDetails>string</AdditionalDetails>
            <ProductInformation xsi:nil="true" />
            <ProductType>string</ProductType>
            <RiskCategory>string</RiskCategory>
          </Product>
        </Data>
      </RetrieveSetByWebsiteResult>
    </RetrieveSetByWebsiteResponse>
  </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/Products.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>
    <RetrieveSetByWebsite xmlns="http://www.estaronline.com/api/">
      <authenticationToken>string</authenticationToken>
      <styles>
        <string>string</string>
        <string>string</string>
      </styles>
      <website>int</website>
    </RetrieveSetByWebsite>
  </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>
    <RetrieveSetByWebsiteResponse xmlns="http://www.estaronline.com/api/">
      <RetrieveSetByWebsiteResult>
        <Data>
          <Product>
            <ID>int</ID>
            <Title>string</Title>
            <ShortDescription>string</ShortDescription>
            <LongDescription>string</LongDescription>
            <Supplier>string</Supplier>
            <Style>string</Style>
            <Status>int</Status>
            <AvailableFrom>dateTime</AvailableFrom>
            <Price>decimal</Price>
            <Cost>decimal</Cost>
            <ContentLocked>boolean</ContentLocked>
            <ForeignIdentity>string</ForeignIdentity>
            <Weight>double</Weight>
            <Manufacturer>string</Manufacturer>
            <DateCreated>dateTime</DateCreated>
            <Items xsi:nil="true" />
            <ProductCompositeType>Product or Group or Set</ProductCompositeType>
            <CompositeChildren xsi:nil="true" />
            <Catalogues xsi:nil="true" />
            <Aspects xsi:nil="true" />
            <ProductAspects xsi:nil="true" />
            <Metadata xsi:nil="true" />
            <Images xsi:nil="true" />
            <AdditionalDetails>string</AdditionalDetails>
            <ProductInformation xsi:nil="true" />
            <ProductType>string</ProductType>
            <RiskCategory>string</RiskCategory>
          </Product>
          <Product>
            <ID>int</ID>
            <Title>string</Title>
            <ShortDescription>string</ShortDescription>
            <LongDescription>string</LongDescription>
            <Supplier>string</Supplier>
            <Style>string</Style>
            <Status>int</Status>
            <AvailableFrom>dateTime</AvailableFrom>
            <Price>decimal</Price>
            <Cost>decimal</Cost>
            <ContentLocked>boolean</ContentLocked>
            <ForeignIdentity>string</ForeignIdentity>
            <Weight>double</Weight>
            <Manufacturer>string</Manufacturer>
            <DateCreated>dateTime</DateCreated>
            <Items xsi:nil="true" />
            <ProductCompositeType>Product or Group or Set</ProductCompositeType>
            <CompositeChildren xsi:nil="true" />
            <Catalogues xsi:nil="true" />
            <Aspects xsi:nil="true" />
            <ProductAspects xsi:nil="true" />
            <Metadata xsi:nil="true" />
            <Images xsi:nil="true" />
            <AdditionalDetails>string</AdditionalDetails>
            <ProductInformation xsi:nil="true" />
            <ProductType>string</ProductType>
            <RiskCategory>string</RiskCategory>
          </Product>
        </Data>
      </RetrieveSetByWebsiteResult>
    </RetrieveSetByWebsiteResponse>
  </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/Products.asmx/RetrieveSetByWebsite?authenticationToken=string&styles=string&styles=string&website=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"?>
<ProductApiResponse xmlns="http://www.estaronline.com/api/">
  <Data>
    <Product>
      <ID>int</ID>
      <Title>string</Title>
      <ShortDescription>string</ShortDescription>
      <LongDescription>string</LongDescription>
      <Supplier>string</Supplier>
      <Style>string</Style>
      <Status>int</Status>
      <AvailableFrom>dateTime</AvailableFrom>
      <Price>decimal</Price>
      <Cost>decimal</Cost>
      <ContentLocked>boolean</ContentLocked>
      <ForeignIdentity>string</ForeignIdentity>
      <Weight>double</Weight>
      <Manufacturer>string</Manufacturer>
      <DateCreated>dateTime</DateCreated>
      <Items>
        <ProductItem d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <ProductItem d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Items>
      <ProductCompositeType>Product or Group or Set</ProductCompositeType>
      <CompositeChildren>
        <ChildProduct d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <ChildProduct d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </CompositeChildren>
      <Catalogues>
        <string>string</string>
        <string>string</string>
      </Catalogues>
      <Aspects>
        <NameValuePair d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <NameValuePair d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Aspects>
      <ProductAspects>
        <Aspect d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <Aspect d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </ProductAspects>
      <Metadata>
        <NameValuePair d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <NameValuePair d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Metadata>
      <Images>
        <NameValuePair d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <NameValuePair d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Images>
      <AdditionalDetails>string</AdditionalDetails>
      <ProductInformation>
        <NameValuePair d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <NameValuePair d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </ProductInformation>
      <ProductType>string</ProductType>
      <RiskCategory>string</RiskCategory>
    </Product>
    <Product>
      <ID>int</ID>
      <Title>string</Title>
      <ShortDescription>string</ShortDescription>
      <LongDescription>string</LongDescription>
      <Supplier>string</Supplier>
      <Style>string</Style>
      <Status>int</Status>
      <AvailableFrom>dateTime</AvailableFrom>
      <Price>decimal</Price>
      <Cost>decimal</Cost>
      <ContentLocked>boolean</ContentLocked>
      <ForeignIdentity>string</ForeignIdentity>
      <Weight>double</Weight>
      <Manufacturer>string</Manufacturer>
      <DateCreated>dateTime</DateCreated>
      <Items>
        <ProductItem d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <ProductItem d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Items>
      <ProductCompositeType>Product or Group or Set</ProductCompositeType>
      <CompositeChildren>
        <ChildProduct d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <ChildProduct d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </CompositeChildren>
      <Catalogues>
        <string>string</string>
        <string>string</string>
      </Catalogues>
      <Aspects>
        <NameValuePair d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <NameValuePair d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Aspects>
      <ProductAspects>
        <Aspect d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <Aspect d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </ProductAspects>
      <Metadata>
        <NameValuePair d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <NameValuePair d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Metadata>
      <Images>
        <NameValuePair d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <NameValuePair d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Images>
      <AdditionalDetails>string</AdditionalDetails>
      <ProductInformation>
        <NameValuePair d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <NameValuePair d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </ProductInformation>
      <ProductType>string</ProductType>
      <RiskCategory>string</RiskCategory>
    </Product>
  </Data>
</ProductApiResponse>

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

authenticationToken=string&styles=string&styles=string&website=string

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

<?xml version="1.0" encoding="utf-8"?>
<ProductApiResponse xmlns="http://www.estaronline.com/api/">
  <Data>
    <Product>
      <ID>int</ID>
      <Title>string</Title>
      <ShortDescription>string</ShortDescription>
      <LongDescription>string</LongDescription>
      <Supplier>string</Supplier>
      <Style>string</Style>
      <Status>int</Status>
      <AvailableFrom>dateTime</AvailableFrom>
      <Price>decimal</Price>
      <Cost>decimal</Cost>
      <ContentLocked>boolean</ContentLocked>
      <ForeignIdentity>string</ForeignIdentity>
      <Weight>double</Weight>
      <Manufacturer>string</Manufacturer>
      <DateCreated>dateTime</DateCreated>
      <Items>
        <ProductItem d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <ProductItem d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Items>
      <ProductCompositeType>Product or Group or Set</ProductCompositeType>
      <CompositeChildren>
        <ChildProduct d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <ChildProduct d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </CompositeChildren>
      <Catalogues>
        <string>string</string>
        <string>string</string>
      </Catalogues>
      <Aspects>
        <NameValuePair d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <NameValuePair d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Aspects>
      <ProductAspects>
        <Aspect d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <Aspect d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </ProductAspects>
      <Metadata>
        <NameValuePair d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <NameValuePair d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Metadata>
      <Images>
        <NameValuePair d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <NameValuePair d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Images>
      <AdditionalDetails>string</AdditionalDetails>
      <ProductInformation>
        <NameValuePair d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <NameValuePair d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </ProductInformation>
      <ProductType>string</ProductType>
      <RiskCategory>string</RiskCategory>
    </Product>
    <Product>
      <ID>int</ID>
      <Title>string</Title>
      <ShortDescription>string</ShortDescription>
      <LongDescription>string</LongDescription>
      <Supplier>string</Supplier>
      <Style>string</Style>
      <Status>int</Status>
      <AvailableFrom>dateTime</AvailableFrom>
      <Price>decimal</Price>
      <Cost>decimal</Cost>
      <ContentLocked>boolean</ContentLocked>
      <ForeignIdentity>string</ForeignIdentity>
      <Weight>double</Weight>
      <Manufacturer>string</Manufacturer>
      <DateCreated>dateTime</DateCreated>
      <Items>
        <ProductItem d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <ProductItem d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Items>
      <ProductCompositeType>Product or Group or Set</ProductCompositeType>
      <CompositeChildren>
        <ChildProduct d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <ChildProduct d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </CompositeChildren>
      <Catalogues>
        <string>string</string>
        <string>string</string>
      </Catalogues>
      <Aspects>
        <NameValuePair d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <NameValuePair d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Aspects>
      <ProductAspects>
        <Aspect d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <Aspect d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </ProductAspects>
      <Metadata>
        <NameValuePair d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <NameValuePair d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Metadata>
      <Images>
        <NameValuePair d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <NameValuePair d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Images>
      <AdditionalDetails>string</AdditionalDetails>
      <ProductInformation>
        <NameValuePair d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <NameValuePair d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </ProductInformation>
      <ProductType>string</ProductType>
      <RiskCategory>string</RiskCategory>
    </Product>
  </Data>
</ProductApiResponse>