XML Feed Specification

XML feed specification for Findify

Introduction

This document presents the product feed specification for the XML feeds to be sent to Findify.

In order for Findify to synchronize periodically your products with our system, the XML file must be publicly accessible. Findify is supporting feeds available via HTTP or HTTPS (behind a basic authentication).

Mandatory fields

Name of the fieldDescriptionExample
idUnique identifier of the product. This identifier must be unique across all products.tddy123uk
item_group_idCommon identifier for all variants of the same product. If there are no variants present for the product, use the same value as id89A
titleTitle of the product.Men's Pique Polo Shirt
descriptionDescription of the product. The description should not be written over multiples lines.Solid red, king-sized bed sheets made from 100% woven polyester 300-thread count fabric. Set includes one fitted sheet, one flat sheet and two standard pillowcases. Machine washable; extra-deep fitted pockets.
pricePrice of the product.15.99
image_urlURL of the image of the product. For the best-displaying quality, the image must have a size of 180px * 180px.http://www.example.co.uk/image1.jpg
product_urlURL of the product’s page.http://www.example.com/asp/sp.asp?cat=12&id=1030
categoryCategory of the product. Subcategories are split using the > delimiter. It's possible to include several groups of categories by separating them with the ### delimiter.Clothing & Accessories > Clothing > Dresses
thumbnail_urlURL of the thumbnail image of the product. The thumbnail image must have a size of 65px * 65px.http://www.example.co.uk/image1_thumb.jpg
availabilityAvailability status of the product (‘in stock” or “out of stock”).in stock
created_atDate when the product has been made available to the users (format ISO-8601).2014-04-22T06:00:00Z
updated_atDate when the product has been updated last (format ISO-8601).2014-04-22T06:00:00Z

Optional fields

Name of the fieldDescriptionExample
skuSKU of the product. Even if the "id" of the product is the SKU, you need to add a dedicated "sku" field.126373-AOP
brandBrand of the product.Calvin Klein
sellerSeller of the product.Calvin Shop
sale_priceAdvertised sale price of the product.13.65
materialMaterial of the product.cotton
colorColor of the product.red
costCost of the product. margin = price - cost10.50
sizeSize of the product.34
quantityQuantity of the product98
created_atDate when the product has been made available to the users (format ISO-8601).2014-04-22T06:00:00Z
reviews.average_scoreRating score of the product3.5
reviews.countRatings amount per product13
name_custom_fieldA custom field that contains one specific information.**

Custom fields

Custom fields that are not part of the model above but can be specified in the feed. Custom fields can contain a large panel of information, specific to your products or to your business. Custom fields can be configured to be used as a searchable field or as a filter in the Findify Merchant Dashboard.

At the moment, only custom fields that have a type of String or Double are accepted.

To include new custom fields, add a new element which name is the custom field name in the product element.

Variants

Your feed can contain variants. Specifying the optional field item_group_id and filling it with a common value for the variants you want to group will let us group these variants into 1 product.

If your model does not permit it, grouping the variants according to the product URL or another field from the set of mandatory fields is also possible. Let us know at [email protected]findify.io if you want to make this happen.

Product feed example in XML

The following example contains all the mandatory fields, some of the optional fields and the custom_field "gender".

<?xml version="1.0" encoding="UTF-8"?>
<products>
    <product>
        <id><![CDATA[tddy123uk]]></id>
    <item_group_id><![CDATA[tddy123uk]]></item_group_id>
        <sku><![CDATA[126373-AOP]]></sku>
        <title><![CDATA[Men's Pique Polo Shirt]]></title>
        <description><![CDATA[Solid red, king-sized bed sheets made from 100% woven polyester 300-thread count fabric. Set includes one fitted sheet, one flat sheet and two standard pillowcases. Machine washable; extra-deep fitted pockets.]]></description>
        <price><![CDATA[15.99]]></price>
        <sale_price><![CDATA[10.99]]></sale_price>
        <image_url><![CDATA[http://www.example.co.uk/image1.jpg]]></image_url>
        <product_url><![CDATA[http://www.example.com/asp/sp.asp?cat=12&id=1030]]></product_url>
        <category><![CDATA[Clothing & Accessories > Clothing > Dresses]]></category>
        <thumbnail_url><![CDATA[http://www.example.co.uk/image1_thumb.jpg]]></thumbnail_url>
        <availability><![CDATA[in stock]]></availability>
        <created_at><![CDATA[2014-04-22T06:00:00Z]]></created_at>
        <brand><![CDATA[Calvin Klein]]></brand>
        <color><![CDATA[Musta]]></color>
        <size><![CDATA[M]]></size>
        <item_group_id><![CDATA[89A]]></item_group_id>
        <quantity><![CDATA[17]]></quantity>
        <gender>Male</gender>
    </product>
    <product>
    <product>
        <id><![CDATA[ppp333sss]]></id>
        <sku><![CDATA[12000-PPP]]></sku>
        <title><![CDATA[Men's Pique Polo Shirt Size L]]></title>
        <description><![CDATA[Solid red, king-sized bed sheets made from 100% woven polyester 300-thread count fabric. Set includes one fitted sheet, one flat sheet and two standard pillowcases. Machine washable; extra-deep fitted pockets.]]></description>
        <price><![CDATA[20.99]]></price>
        <sale_price><![CDATA[11.99]]></sale_price>
        <image_url><![CDATA[http://www.example.co.uk/image4.jpg]]></image_url>
        <product_url><![CDATA[http://www.example.com/asp/sp.asp?cat=12&id=0001]]></product_url>
        <category><![CDATA[Clothing & Accessories > Clothing > Dresses]]></category>
        <thumbnail_url><![CDATA[http://www.example.co.uk/image1_thumb.jpg]]></thumbnail_url>
        <availability><![CDATA[in stock]]></availability>
        <created_at><![CDATA[2014-04-22T06:00:00Z]]></created_at>
        <brand><![CDATA[Calvin Klein]]></brand>
        <color><![CDATA[Musta]]></color>
        <size><![CDATA[L]]></size>
        <item_group_id><![CDATA[89A]]></item_group_id>
        <quantity><![CDATA[18]]></quantity>
        <gender>Male</gender>
    </product>
    <product>
        ...
    </product>
</products>

Remove some products from appearing in the search

It is possible to remove some products from the search. This can be useful when the feed is automatically generated. In order to remove some products, you need to add another field named “tags” and give it the value findify-remove.

In case you have already tags in your feed, separate the value findify-remove from the other values with a comma: “findify-remove, tag1, tag2”.