Product Calls

The calls on this page relate to products. Please note when a product is ordered, it is reffered to as an order item.

All calls that return custom field values (product metadata fields, order fields, user profile fields etc.) only return values stored in the Storefront database. Values dynamically retrieved from remote data sources (such as third party web services and APIs) are not returned.

GetProduct

This call returns information about a single product.

Request

POST /roiwebinterface.asmx HTTP/1.1
Host: support865.roi360.co.uk
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>
    <GetProduct xmlns="http://roidistribution.com/webapi">
      <productId>string</productId>
      <token>string</token>
    </GetProduct>
  </soap12:Body>
</soap12:Envelope>

<productId> - the ID of the product to view
<token> - the authorisation token to validate the API call

Response

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>
    <GetProductResponse xmlns="http://roidistribution.com/webapi">
      <GetProductResult>
        <ProductId>string</ProductId>
        <Name>string</Name>
        <Description>string</Description>
        <CustomProductFields>
          <CustomField>
            <Name>string</Name>
            <Value>string</Value>
          </CustomField>
          <CustomField>
            <Name>string</Name>
            <Value>string</Value>
          </CustomField>
        </CustomProductFields>
        <CustomProductCategories>
          <ProductCategory>
            <Id>string</Id>
            <DisplayName>string</DisplayName>
          </ProductCategory>
          <ProductCategory>
            <Id>string</Id>
            <DisplayName>string</DisplayName>
          </ProductCategory>
        </CustomProductCategories>
      </GetProductResult>
    </GetProductResponse>
  </soap12:Body>
</soap12:Envelope>

<ProductId> - the ID of the product
<Name> - the name of the product
<Description> - a description for the product which may be empty
<CustomProductFields> - A list of custom field key-value pairs of the product’s metadata
<CustomProductCategories> - A list of product category key value pairs for the categories the product is in

GetProductList

This call returns information about multiple products.

Request

POST /roiwebinterface.asmx HTTP/1.1
Host: support865.roi360.co.uk
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>
    <GetProductList xmlns="http://roidistribution.com/webapi">
      <prodIdList>
        <string>string</string>
        <string>string</string>
      </prodIdList>
      <token>string</token>
    </GetProductList>
  </soap12:Body>
</soap12:Envelope>

<string> - a list of the product IDs to view
<token> - the authorisation token to validate the API call

Response

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>
    <GetProductListResponse xmlns="http://roidistribution.com/webapi">
      <GetProductListResult>
        <Product>
          <ProductId>string</ProductId>
          <Name>string</Name>
          <Description>string</Description>
          <CustomProductFields>
            <CustomField xsi:nil="true" />
            <CustomField xsi:nil="true" />
          </CustomProductFields>
          <CustomProductCategories>
            <ProductCategory xsi:nil="true" />
            <ProductCategory xsi:nil="true" />
          </CustomProductCategories>
        </Product>
        <Product>
          <ProductId>string</ProductId>
          <Name>string</Name>
          <Description>string</Description>
          <CustomProductFields>
            <CustomField xsi:nil="true" />
            <CustomField xsi:nil="true" />
          </CustomProductFields>
          <CustomProductCategories>
            <ProductCategory xsi:nil="true" />
            <ProductCategory xsi:nil="true" />
          </CustomProductCategories>
        </Product>
      </GetProductListResult>
    </GetProductListResponse>
  </soap12:Body>
</soap12:Envelope>

<ProductId> - the ID of the product
<Name> - the name of the product
<Description> - a description for the product which may be empty
<CustomProductFields> - a list of custom field key-value pairs of the product’s metadata
<CustomProductCategories> - a list of product category key value pairs for the categories the product is in

GetProductIdListOfActiveProducts

This call returns a list of active product IDs.

Request

POST /roiwebinterface.asmx HTTP/1.1
Host: support865.roi360.co.uk
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>
    <GetProductIdListOfActiveProducts xmlns="http://roidistribution.com/webapi">
      <token>string</token>
    </GetProductIdListOfActiveProducts>
  </soap12:Body>
</soap12:Envelope>

<token> - the authorisation token to validate the API call

Response

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>
    <GetProductIdListOfActiveProductsResponse xmlns="http://roidistribution.com/webapi">
      <GetProductIdListOfActiveProductsResult>
        <string>string</string>
        <string>string</string>
      </GetProductIdListOfActiveProductsResult>
    </GetProductIdListOfActiveProductsResponse>
  </soap12:Body>
</soap12:Envelope>

<string> - the ID of the active product