skip to Main Content

Reuqired fields are necessary for basic functionality.

Optional fields depend on Persoo features you want to use and also on the business segment (i.e. fashion has sizes, but books don’t).
You can add as many custom fields, as you need.

Note! Fields with multiple values can be added multiple times into the feed. E.g. if the product is assigned in more than one category, multiple category fields can be generated.

List of required and optional fields

Required:

  • itemID
  • itemGroupID
  • categoryID
  • title
  • description
  • link
  • imageLink
  • hierarchy
  • available

Optional:

  • brand
  • color
  • productType
  • hierarchyID
  • priceOriginal
  • relatedProducts
  • basketLink
  • imageLink2
  • etc…

Product fields details

Important note! When providing values for product parameters, always include some form of value. Even if there is no value for “brand” for example, fill it with text “undefined” or some other string value.

itemID (string)

<id>28752</id>

Product’s unique ID.

itemGroupID (string)

<item_group_id>28752</item_group_id>

Required in case more variants of the same product exist.

It pairs product variants with their master. More on grouping products here.

hierarchyID (string)

<hierarchy_id>111:222:333</hierarchy_id>
<hierarchy_id>555:666:777</hierarchy_id>

Tree structure of category, in which is the product assigned. Each level ID must be unique, ideally numeric (since if the category 333 and 777 are both named “Accessories”, this would cause problems. If the product exists in more than one hierarchy, multiple tags <g:hierarchy_id> are listed. The first hierarchy is assumed as the main hierarchy.

categoryID (string)

<category_id>333</category_id>
<category_id>777</category_id>

Category, in which the product is assigned. Identical with the last item in hierarchy. If the product exists in more than one category, multiple tags are listed. The first categoryID is assumed as the main categoryID.

This filed represents one unique deepest category into which products can be placed. It must not happen that two categories (i.e. “Men – Shirts” and “Women – Shirts”) have the same categoryID.

title (string)

<title>TIMEX TW2P98300</title>

Product title (name of the product). To be displayed in product lists.

description (string)

<description>Great watch for everybody!</description>

String with short product description (pure text without HTML tags)

hierarchy (string)

<hierarchy>Men's watches|Silver watches</hierarchy>
<hierarchy>Sport watches|Water resistant|10atm</hierarchy>

Text hierarchy for fulltext search.

category (string)

<category>Silver watches</category>
<category>10atm</category>

Text category for fulltext search.

price (integer)

<price>74</price>

Final price including VAT.

priceOriginal (integer)

<price_original>99</price_original>

Original price, required if the product was discounted.

link (string)

<link>https://www.shop.com/timex-tw2p98300</link>

Product detail URL.

Important note! When providing links for the products or their images, consider prepending correct HTTP/HTTPS protocol, otherwise some functions might not work, and your visitors will be redirected to non-secure locations!

imageLink (string)

<image_link>https://www.shop.com/images/image_28752_19_v1.png</image_link>

Thumbnail’s URL. Ideally square format (e.g. 140 x 140 px). Size should be the same as the largest thumbnail used on the site (to speed up loading time). If also larger image is needed, another custom field with a link to larger image should be added (e.g. <g:image_link_large>).

available (integer)

<available>4</available>

Gives numeric value of the number of items available in stock (for immediate shipping)

basketLink (string)

<basket_link>https://www.shop.com/addBasket?timex-tw2p98300</basket_link>

Link for inserting the product in the basket.

productType (string)

<product_type>watch</product_type>

Helps to identify the product independently from the hierarchy. E.g. a “spring mattress”, “foam mattress”, “latex mattress” can be categories, but the overall type is “mattress”. If this is not reflected in the categories/hierarchies, we recommend using the product type field.

relatedProducts (string)

<related_products>112</related_products>
<related_products>113</related_products>
<related_products>117</related_products>

If you want to specify products related in some way (suitable cross-sell, alternatives, free gifts/discounts etc.). Note: products from the same product group (i.e. same shoe of different sizes) should be handled as described here.

attributeNew (bool)

<attribute_new>true</attribute_new>

A label stating the product is a recent addition.

 

deliveryDate (number)

<delivery_date>14</delivery_date>

Number of days before the product can be shipped. State zero “0” for immediate availability (in stock).

<otherCustomFields>

… and other fields that are needed, such as brand, size, color, gender, collection

Note! We use camelCase notation, but in XML, which does not distiguish between lowercase and uppercase, fields are written as <camel_case> and are automatically converted to camelCase during product import processing.

Back To Top
×Close search
Search