Products feed
- Product feed contains all products that are in the database. Because there is a direct link between Orders feed and Products feed, all products listed in the Order feed must be in the Product feed. Otherwise we are not able to include this product into the YOTTLY analytics engine because there is no information about it.
- Each product may have unlimited number of variants. A product variant is the same product with different parameters e.g. different color, different size, different package size etc. Each product variant may overwrite all attributes of parent product except for CATEGORYTEXT and BRAND. If the attribute is not specified for a given variant, its value is inherited from the parent product.
- Products can have the most metadata parameters from all feeds. We recommend to provide as many parameters as you need – you will be able to filter your customers according to their interaction with products of such parameters.
Field name | Field type | Required | Description |
---|---|---|---|
PRODUCT_ID | String | yes | internal product ID |
TITLE | String | yes | Product’s title |
PRICE | Float, >0 | yes | Product’s price including VAT. |
URL | String | yes | Direct URL to given product. |
IMAGE | String | no | Direct URL to product’s image. This image should match the main image of a product. An image with dimensions around 300x300px is expected |
DESCRIPTION | String | no | Product’s description (plain text without HTML tags) |
BRAND | String | no | Product’s brand |
STOCK | Integer | no | Number of pieces on stock. Must be >=0 (default: STOCK=1) |
PRICE_BEFORE_DISCOUNT | Float, > 0 | no | Price of a product before discount. |
PRICE_BUY | Float, > 0 | no | Buy price of a product |
CATEGORYTEXT | String | no | Path of category names separated by the vertical bar "|" |
PRODUCT_LINE | String | no | Product’s line |
VARIANT | List of Product | no | See product variants for details. Variant of a product e.g. different t-shirt size. All fields may be rewritten except for CATEGORYTEXT and BRAND. Each variant needs to have unique PRODUCT_ID that will be later used in Orders feed in ITEMS as a identificator of an ordered product. All other fields are optional. |
SHOW | Boolean | no | Product should be promoted or not (default SHOW=True). |
PARAMETER | [par1,par2] | no | Parameters for given product |
Variants
Variants are used to group several products (in the case of different package size for example).
If no variants are specified, single variant will be formed from the product definition.
Each variant is formed by taking fields present in top-level product and attaching fields from the variant. When a field is present in both top-level product and a variant, the field from variant takes precedence.
All fields allowed in top-level product are allowed.
XML format
<?xml version="1.0" encoding="utf-8"?> <PRODUCTS> <PRODUCT> <PRODUCT_ID>D45S8741545SD</PRODUCT_ID> <EAN>467891186861118</EAN> <BRAND>Unknown Brand</BRAND> <TITLE>Product title</TITLE> <DESCRIPTION>Product's description with unlimited length</DESCRIPTION> <PRICE>42.1</PRICE> <PRICE_BEFORE_DISCOUNT>40.1</PRICE_BEFORE_DISCOUNT> <STOCK>60</STOCK> <URL>http://www.someurl.com/path/to/product</URL> <IMAGE>http://static.someurl.com/path/to/image</IMAGE> <CATEGORYTEXT>Clothing | T-shirts</CATEGORYTEXT> <PARAMETERS> <PARAMETER> <NAME>Color</NAME> <VALUE>blue</VALUE> </PARAMETER> <PARAMETERS> <VARIANT> <PRODUCT_ID>D45S8741545SD-XXL</PRODUCT_ID> <TITLE>Product title</TITLE> <DESCRIPTION>Product's description with unlimited length</DESCRIPTION> <PARAMETERS> <PARAMETER> <NAME>size</NAME> <VALUE>XXL</NAME> </PARAMETER> </PARAMETERS> <PRICE>42.1</PRICE> <STOCK>10</STOCK> <IMAGE>http://static.someurl.com/path/to/xxl-image</IMAGE> <URL>http://www.someurl.com/path/to/product?variant=xxl</URL> </VARIANT> </PRODUCT> </PRODUCTS>