iSAMS Products API Web Service

iSAMS Products API

Click here for a complete list of operations.

PatchProduct

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

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

<?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>
    <PatchProduct xmlns="http://www.estaronline.com/api/">
      <authenticationToken>string</authenticationToken>
      <fields>string</fields>
      <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>
            <ID>int</ID>
            <Style>string</Style>
            <Barcode>string</Barcode>
            <Size>string</Size>
            <SizeCode>string</SizeCode>
            <Colour>string</Colour>
            <ColourCode>string</ColourCode>
            <Price>decimal</Price>
            <Cost>decimal</Cost>
            <Quantity>int</Quantity>
            <Weight>double</Weight>
            <ForeignIdentity>string</ForeignIdentity>
            <AvailableFrom>dateTime</AvailableFrom>
            <InStock>boolean</InStock>
            <Retail>decimal</Retail>
            <AdditionalDetails>string</AdditionalDetails>
            <Availability xsi:nil="true" />
            <Aspects xsi:nil="true" />
            <Images xsi:nil="true" />
          </ProductItem>
          <ProductItem>
            <ID>int</ID>
            <Style>string</Style>
            <Barcode>string</Barcode>
            <Size>string</Size>
            <SizeCode>string</SizeCode>
            <Colour>string</Colour>
            <ColourCode>string</ColourCode>
            <Price>decimal</Price>
            <Cost>decimal</Cost>
            <Quantity>int</Quantity>
            <Weight>double</Weight>
            <ForeignIdentity>string</ForeignIdentity>
            <AvailableFrom>dateTime</AvailableFrom>
            <InStock>boolean</InStock>
            <Retail>decimal</Retail>
            <AdditionalDetails>string</AdditionalDetails>
            <Availability xsi:nil="true" />
            <Aspects xsi:nil="true" />
            <Images xsi:nil="true" />
          </ProductItem>
        </Items>
        <ProductCompositeType>Product or Group or Set</ProductCompositeType>
        <CompositeChildren>
          <ChildProduct>
            <Style xmlns="http://www.estaronline.com/api">string</Style>
            <ParentStyle xmlns="http://www.estaronline.com/api">string</ParentStyle>
            <Type xmlns="http://www.estaronline.com/api">Included or Optional or Required</Type>
            <Quantity xmlns="http://www.estaronline.com/api">int</Quantity>
            <Price xmlns="http://www.estaronline.com/api">decimal</Price>
            <Order xmlns="http://www.estaronline.com/api">int</Order>
          </ChildProduct>
          <ChildProduct>
            <Style xmlns="http://www.estaronline.com/api">string</Style>
            <ParentStyle xmlns="http://www.estaronline.com/api">string</ParentStyle>
            <Type xmlns="http://www.estaronline.com/api">Included or Optional or Required</Type>
            <Quantity xmlns="http://www.estaronline.com/api">int</Quantity>
            <Price xmlns="http://www.estaronline.com/api">decimal</Price>
            <Order xmlns="http://www.estaronline.com/api">int</Order>
          </ChildProduct>
        </CompositeChildren>
        <Catalogues>
          <string>string</string>
          <string>string</string>
        </Catalogues>
        <Aspects>
          <NameValuePair>
            <Name>string</Name>
            <Value>string</Value>
          </NameValuePair>
          <NameValuePair>
            <Name>string</Name>
            <Value>string</Value>
          </NameValuePair>
        </Aspects>
        <ProductAspects>
          <Aspect>
            <Name>string</Name>
            <Value>string</Value>
            <Group>string</Group>
            <ProductID>int</ProductID>
            <ProductItemID>int</ProductItemID>
            <Style>string</Style>
            <Barcode>string</Barcode>
          </Aspect>
          <Aspect>
            <Name>string</Name>
            <Value>string</Value>
            <Group>string</Group>
            <ProductID>int</ProductID>
            <ProductItemID>int</ProductItemID>
            <Style>string</Style>
            <Barcode>string</Barcode>
          </Aspect>
        </ProductAspects>
        <Metadata>
          <NameValuePair>
            <Name>string</Name>
            <Value>string</Value>
          </NameValuePair>
          <NameValuePair>
            <Name>string</Name>
            <Value>string</Value>
          </NameValuePair>
        </Metadata>
        <Images>
          <NameValuePair>
            <Name>string</Name>
            <Value>string</Value>
          </NameValuePair>
          <NameValuePair>
            <Name>string</Name>
            <Value>string</Value>
          </NameValuePair>
        </Images>
        <AdditionalDetails>string</AdditionalDetails>
        <ProductInformation>
          <NameValuePair>
            <Name>string</Name>
            <Value>string</Value>
          </NameValuePair>
          <NameValuePair>
            <Name>string</Name>
            <Value>string</Value>
          </NameValuePair>
        </ProductInformation>
        <ProductType>string</ProductType>
        <RiskCategory>string</RiskCategory>
      </product>
    </PatchProduct>
  </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>
    <PatchProductResponse xmlns="http://www.estaronline.com/api/">
      <PatchProductResult>
        <Data>
          <string>string</string>
          <string>string</string>
        </Data>
      </PatchProductResult>
    </PatchProductResponse>
  </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>
    <PatchProduct xmlns="http://www.estaronline.com/api/">
      <authenticationToken>string</authenticationToken>
      <fields>string</fields>
      <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>
            <ID>int</ID>
            <Style>string</Style>
            <Barcode>string</Barcode>
            <Size>string</Size>
            <SizeCode>string</SizeCode>
            <Colour>string</Colour>
            <ColourCode>string</ColourCode>
            <Price>decimal</Price>
            <Cost>decimal</Cost>
            <Quantity>int</Quantity>
            <Weight>double</Weight>
            <ForeignIdentity>string</ForeignIdentity>
            <AvailableFrom>dateTime</AvailableFrom>
            <InStock>boolean</InStock>
            <Retail>decimal</Retail>
            <AdditionalDetails>string</AdditionalDetails>
            <Availability xsi:nil="true" />
            <Aspects xsi:nil="true" />
            <Images xsi:nil="true" />
          </ProductItem>
          <ProductItem>
            <ID>int</ID>
            <Style>string</Style>
            <Barcode>string</Barcode>
            <Size>string</Size>
            <SizeCode>string</SizeCode>
            <Colour>string</Colour>
            <ColourCode>string</ColourCode>
            <Price>decimal</Price>
            <Cost>decimal</Cost>
            <Quantity>int</Quantity>
            <Weight>double</Weight>
            <ForeignIdentity>string</ForeignIdentity>
            <AvailableFrom>dateTime</AvailableFrom>
            <InStock>boolean</InStock>
            <Retail>decimal</Retail>
            <AdditionalDetails>string</AdditionalDetails>
            <Availability xsi:nil="true" />
            <Aspects xsi:nil="true" />
            <Images xsi:nil="true" />
          </ProductItem>
        </Items>
        <ProductCompositeType>Product or Group or Set</ProductCompositeType>
        <CompositeChildren>
          <ChildProduct>
            <Style xmlns="http://www.estaronline.com/api">string</Style>
            <ParentStyle xmlns="http://www.estaronline.com/api">string</ParentStyle>
            <Type xmlns="http://www.estaronline.com/api">Included or Optional or Required</Type>
            <Quantity xmlns="http://www.estaronline.com/api">int</Quantity>
            <Price xmlns="http://www.estaronline.com/api">decimal</Price>
            <Order xmlns="http://www.estaronline.com/api">int</Order>
          </ChildProduct>
          <ChildProduct>
            <Style xmlns="http://www.estaronline.com/api">string</Style>
            <ParentStyle xmlns="http://www.estaronline.com/api">string</ParentStyle>
            <Type xmlns="http://www.estaronline.com/api">Included or Optional or Required</Type>
            <Quantity xmlns="http://www.estaronline.com/api">int</Quantity>
            <Price xmlns="http://www.estaronline.com/api">decimal</Price>
            <Order xmlns="http://www.estaronline.com/api">int</Order>
          </ChildProduct>
        </CompositeChildren>
        <Catalogues>
          <string>string</string>
          <string>string</string>
        </Catalogues>
        <Aspects>
          <NameValuePair>
            <Name>string</Name>
            <Value>string</Value>
          </NameValuePair>
          <NameValuePair>
            <Name>string</Name>
            <Value>string</Value>
          </NameValuePair>
        </Aspects>
        <ProductAspects>
          <Aspect>
            <Name>string</Name>
            <Value>string</Value>
            <Group>string</Group>
            <ProductID>int</ProductID>
            <ProductItemID>int</ProductItemID>
            <Style>string</Style>
            <Barcode>string</Barcode>
          </Aspect>
          <Aspect>
            <Name>string</Name>
            <Value>string</Value>
            <Group>string</Group>
            <ProductID>int</ProductID>
            <ProductItemID>int</ProductItemID>
            <Style>string</Style>
            <Barcode>string</Barcode>
          </Aspect>
        </ProductAspects>
        <Metadata>
          <NameValuePair>
            <Name>string</Name>
            <Value>string</Value>
          </NameValuePair>
          <NameValuePair>
            <Name>string</Name>
            <Value>string</Value>
          </NameValuePair>
        </Metadata>
        <Images>
          <NameValuePair>
            <Name>string</Name>
            <Value>string</Value>
          </NameValuePair>
          <NameValuePair>
            <Name>string</Name>
            <Value>string</Value>
          </NameValuePair>
        </Images>
        <AdditionalDetails>string</AdditionalDetails>
        <ProductInformation>
          <NameValuePair>
            <Name>string</Name>
            <Value>string</Value>
          </NameValuePair>
          <NameValuePair>
            <Name>string</Name>
            <Value>string</Value>
          </NameValuePair>
        </ProductInformation>
        <ProductType>string</ProductType>
        <RiskCategory>string</RiskCategory>
      </product>
    </PatchProduct>
  </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>
    <PatchProductResponse xmlns="http://www.estaronline.com/api/">
      <PatchProductResult>
        <Data>
          <string>string</string>
          <string>string</string>
        </Data>
      </PatchProductResult>
    </PatchProductResponse>
  </soap12:Body>
</soap12:Envelope>