iSAMS Products API Web Service

iSAMS Products API

Click here for a complete list of operations.

PatchProducts

Patches (applies a partial update) to the specified fields of the set of provided products.

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

<?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>
    <PatchProducts xmlns="http://www.estaronline.com/api/">
      <authenticationToken>string</authenticationToken>
      <fields>string</fields>
      <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 xsi:nil="true" />
            <ProductItem xsi:nil="true" />
          </Items>
          <ProductCompositeType>Product or Group or Set</ProductCompositeType>
          <CompositeChildren>
            <ChildProduct xsi:nil="true" />
            <ChildProduct xsi:nil="true" />
          </CompositeChildren>
          <Catalogues>
            <string>string</string>
            <string>string</string>
          </Catalogues>
          <Aspects>
            <NameValuePair xsi:nil="true" />
            <NameValuePair xsi:nil="true" />
          </Aspects>
          <ProductAspects>
            <Aspect xsi:nil="true" />
            <Aspect xsi:nil="true" />
          </ProductAspects>
          <Metadata>
            <NameValuePair xsi:nil="true" />
            <NameValuePair xsi:nil="true" />
          </Metadata>
          <Images>
            <NameValuePair xsi:nil="true" />
            <NameValuePair xsi:nil="true" />
          </Images>
          <AdditionalDetails>string</AdditionalDetails>
          <ProductInformation>
            <NameValuePair xsi:nil="true" />
            <NameValuePair xsi:nil="true" />
          </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 xsi:nil="true" />
            <ProductItem xsi:nil="true" />
          </Items>
          <ProductCompositeType>Product or Group or Set</ProductCompositeType>
          <CompositeChildren>
            <ChildProduct xsi:nil="true" />
            <ChildProduct xsi:nil="true" />
          </CompositeChildren>
          <Catalogues>
            <string>string</string>
            <string>string</string>
          </Catalogues>
          <Aspects>
            <NameValuePair xsi:nil="true" />
            <NameValuePair xsi:nil="true" />
          </Aspects>
          <ProductAspects>
            <Aspect xsi:nil="true" />
            <Aspect xsi:nil="true" />
          </ProductAspects>
          <Metadata>
            <NameValuePair xsi:nil="true" />
            <NameValuePair xsi:nil="true" />
          </Metadata>
          <Images>
            <NameValuePair xsi:nil="true" />
            <NameValuePair xsi:nil="true" />
          </Images>
          <AdditionalDetails>string</AdditionalDetails>
          <ProductInformation>
            <NameValuePair xsi:nil="true" />
            <NameValuePair xsi:nil="true" />
          </ProductInformation>
          <ProductType>string</ProductType>
          <RiskCategory>string</RiskCategory>
        </Product>
      </product>
    </PatchProducts>
  </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>
    <PatchProductsResponse xmlns="http://www.estaronline.com/api/">
      <PatchProductsResult>
        <Data>
          <string>string</string>
          <string>string</string>
        </Data>
      </PatchProductsResult>
    </PatchProductsResponse>
  </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>
    <PatchProducts xmlns="http://www.estaronline.com/api/">
      <authenticationToken>string</authenticationToken>
      <fields>string</fields>
      <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 xsi:nil="true" />
            <ProductItem xsi:nil="true" />
          </Items>
          <ProductCompositeType>Product or Group or Set</ProductCompositeType>
          <CompositeChildren>
            <ChildProduct xsi:nil="true" />
            <ChildProduct xsi:nil="true" />
          </CompositeChildren>
          <Catalogues>
            <string>string</string>
            <string>string</string>
          </Catalogues>
          <Aspects>
            <NameValuePair xsi:nil="true" />
            <NameValuePair xsi:nil="true" />
          </Aspects>
          <ProductAspects>
            <Aspect xsi:nil="true" />
            <Aspect xsi:nil="true" />
          </ProductAspects>
          <Metadata>
            <NameValuePair xsi:nil="true" />
            <NameValuePair xsi:nil="true" />
          </Metadata>
          <Images>
            <NameValuePair xsi:nil="true" />
            <NameValuePair xsi:nil="true" />
          </Images>
          <AdditionalDetails>string</AdditionalDetails>
          <ProductInformation>
            <NameValuePair xsi:nil="true" />
            <NameValuePair xsi:nil="true" />
          </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 xsi:nil="true" />
            <ProductItem xsi:nil="true" />
          </Items>
          <ProductCompositeType>Product or Group or Set</ProductCompositeType>
          <CompositeChildren>
            <ChildProduct xsi:nil="true" />
            <ChildProduct xsi:nil="true" />
          </CompositeChildren>
          <Catalogues>
            <string>string</string>
            <string>string</string>
          </Catalogues>
          <Aspects>
            <NameValuePair xsi:nil="true" />
            <NameValuePair xsi:nil="true" />
          </Aspects>
          <ProductAspects>
            <Aspect xsi:nil="true" />
            <Aspect xsi:nil="true" />
          </ProductAspects>
          <Metadata>
            <NameValuePair xsi:nil="true" />
            <NameValuePair xsi:nil="true" />
          </Metadata>
          <Images>
            <NameValuePair xsi:nil="true" />
            <NameValuePair xsi:nil="true" />
          </Images>
          <AdditionalDetails>string</AdditionalDetails>
          <ProductInformation>
            <NameValuePair xsi:nil="true" />
            <NameValuePair xsi:nil="true" />
          </ProductInformation>
          <ProductType>string</ProductType>
          <RiskCategory>string</RiskCategory>
        </Product>
      </product>
    </PatchProducts>
  </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>
    <PatchProductsResponse xmlns="http://www.estaronline.com/api/">
      <PatchProductsResult>
        <Data>
          <string>string</string>
          <string>string</string>
        </Data>
      </PatchProductsResult>
    </PatchProductsResponse>
  </soap12:Body>
</soap12:Envelope>