Skip to content

How to create a catalog (english)

Jump to bottom
Camila Alvarez edited this page Jan 2, 2019 · 1 revision

How to create a catalog

The set of products that define a catalog are described via an XML. This XML file contains all the product information that is required to correctly perform searches: categories, images, product title, description, among others. The XML file must follow the structure shown below:

<catalog>
  <products>
      ...product sheets (SKU, url, categories, images and other product info)...
  </products>
  <types>
    <categories>
        ...valid product hierarchy...
    </categories>
    <texts>
        ...Valid text codescódigos de textos válidos...
    </texts>
    <images>
        ...valid image codes...
    </images>
  </types>
</catalog>

Product sheet

The <products> element contains one or more <product> elements used to define all products available in the catalog. A possible product sheet is shown below:

<product code="sku_1" url="http://product-url">
  <categories>
    <category ref_code="categoryA"/>
    <category ref_code="categoryB"/>
  </categories>
  <texts>
    <text ref_code="textA">product name</text>
    <text ref_code="textB">product detail description</text>
  </texts>
  <images>
    <image ref_code="imageA" url_image="https://.../image1.jpg"/>
    <image ref_code="imageB" url_image="https://.../image2.jpg"/>
  </images>
</product>

The attribute code defines the code of the product (typically the SKU). It is mandatory and it must be unique inside the catalog. The url attribute links to the e-commerce page that shows the product detail.

The <image> element defines the product images. It must include at least one image to support visual search, via photo or sketch search. The attribute url_image must be a public URL, which will be used by Impresee's servers to download the image.

The <texts> element defines all products possible textual attributes. These texts are used in the text-based search.

The <category> element defines the categories which the product belongs to. Each product must contain at least one category if grouping by category is desired.

The ref_code attributes make reference to category, image and text codes, which must be declared in the <types> section.

XML Schema

The XML structure can be found in the XML Schema ImpreseeCatalog10.xsd.

Example

An example of a valid catalog can be found here.

Clone this wiki locally