Page tree
Skip to end of metadata
Go to start of metadata

This section helps you generate and prepare an XML-file with all your products meant to be displayed in Product Recommendations in your online store.

 NOTE: if you are a user of any of our Niche Solutions, please add extended parameters to each product (for the explanation see Nihce Solutions)!

This page covers the following:

Generate a Static File

If your XML-file weighs more than 5 megabytes and its generation by the script takes more than 20 seconds, set a scheduled Cron task to generate your XML-file (read "don't give us a direct link to the script that generates the file").

It will give you the following advantages:

  • Reduction of your server workload (without a direct link to the script it would be not possible for somebody to easily organize a DDOS-attack with multiple requests to the script)
  • Instant download of your XML-file: REES46 will be able to instantly download the XML-file and have the most recent catalog updates from you. That ensures your success - the products will always hold highest marketing potential.

Example of scheduled XML-file generation for Cron:

0 */2 * * * php /home/myuser/site/docs/xml.php > /home/myuser/site/docs/rees46.xml

NOTE

In order to speed up the download of your XML-file,, you can compress it using GNU GZIP. REES46 fully supports .gzip format and auto-exacts files for further processing.

MULTIPLE REQUESTS

To load all product images, REES46 may send your server multiple requests. If you notice your server blocks multiple requests from IP 88.99.193.211 (REES46 Technologies), please add this IP address to your white list. Otherwise, REES46 will not be able to access product images, and products without images may be excluded from recommendations.

TAG

 Please notice that we're using a specific root tag 'yml_catalog'! This is not a typo (no 'xml_catalog'), this is an extended format that we're using.

Use Proper Syntax

Format your XML Product Feed according to rules of XML markup language syntax.

Example of the <offer> section in your XML Product Feed:

<!-- id - ID of the product. -->
<!-- Item availability for product recommendations - true or false -->
<offer id="395532" available="true">
  
	<!-- URL of the item with no additional parameters. -->
	<!-- Without 'utm_source' or any other attributes for traffic tracking -->
	<url>http://store.com/items/395532</url>
  
 	<!-- Base price of the product. -->
	<price>847</price>
 
    <!-- "Old" price to use in trigger and digest emails -->
	<oldprice>860</oldprice>
 
    <!-- Relative priority of the product (from 0 to 100) -->
    <price_margin>67</price_margin>
	<!-- Product category. Can include muultiple values. -->  
	<categoryId>57</categoryId>
	<categoryId>32</categoryId>
	<categoryId>313</categoryId>
 
 
    <!-- Product seasonality, i.e. the month(s) this product will be included into product recommendations (e.g. winter boots during the winter). This is an optional parameter. Use number from 1 to 12 to determine the month(s). -->
	<seasonality>1</seasonality>
	<seasonality>3</seasonality>
	<seasonality>4</seasonality>
	<seasonality>6</seasonality>
	
	<!-- Product barcode (if available). -->
	<barcode>123456</barcode>

	<!-- Pictures of the product (to be used in trigger and digest emails) -->
	<picture>http://store.com/items/395532.jpg</picture>
  
	<!-- Name of the product (to be used in trigger and digest emails) -->
	<name>Apple Iphone 6 128 gb</name>
 
	<!-- Data array defining product type, model and its manufacturer (to be used in cross-site analysis of customer behavior) -->
	<typePrefix>Smartphone</typePrefix>
	<vendor>Apple</vendor>
	<vendorCode>APPL</vendorCode>
	<model>iPhone 6 128Gb</model>

    <!-- Product rating. Use an integer from 0 to 5; where 0 - if the product has no rating; 1 to 5 defines the product rating. The rating element is optional. -->
    <rating>5</rating>
  
	<!-- Product description (the use in triggered and digest emails is possible) -->
	<description><![CDATA[The moment you connect with iPhone 7, you will know you’ve never felt anything like it. With a single press, 3D Touch lets you do more than ever before. Live Photos bring your memories to life in a powerfully vivid way. And that’s just the beginning. Take a deeper look at iPhone 7, and you’ll find innovation on every level.]]></description>

</offer>

Specify Geographic Information

It is important to specify this information if your online store has multiple pick-up points within a city/town or outlets in more than one city/town. Add information about location of your outlets, product availability in your pick-up points and price changes city- and pick-up point-wise.

Geographic Location

List all your pick-up points and outlets in the <shop> section:

<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE yml_catalog SYSTEM "shops.dtd">
<yml_catalog date="2016-10-14 17:00">
    <shop>
        <name>Outlet</name>
        <company>Store</company>
        <url>http://www.store.com/</url>

        <locations>
          <location id="1" type="city" name="New York" />
          <location id="2" type="city" name="Washington" />
          <!-- ... -->
          <location id="146" type="store" name="Outlet on Houston street" parentId="1" />      
          <location id="145" type="store" name="Pick-up point on George Washington street" parentId="2" />
        </locations>
        
        <currencies>...</currencies>
        <categories>
          <category id="2" url="http://example.com/categories/discount">Discount</category>
          <category id="8">Man</category>
          <category id="13" parentId="8">T-Shirt</category>
        </categories>
        <offers>...</offers>
    </shop>
</yml_catalog>

 

Product availability and price in your pick-up points/outlets

Specify each product availability status and price for every your pick-up point/outlet in the <offer> section:

<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE yml_catalog SYSTEM "shops.dtd">
<yml_catalog date="2016-10-14 17:00">
    <shop>
        ...
        <offers>
            <offer ...>

                <url>http://store.com/items/395532</url>
                ...

                <!-- If you have outlets in multiple cities/towns: -->
                <locations>
                    
					<!-- Product at the price of 'US $500' is available in the city with ID '1' -->
                    <location id="1">
                        <price>500</price>
                    </location>
                    
					<!-- If you don't specify the price, it takes the base value. -->
                    <location id="2"></location>
                    
					<!-- No block for the city with ID '3'. It means the product is not available there. -->

                    <location id="4">
                        <price>490</price> 	
                    </location>
                </locations>
            </offer>
        </offers>
    </shop>
</yml_catalog>

Rough Number of SKUs Left in Stock

Specify the this value for each product in the <offer> section using the argument leftovers with one of the following values: lot, few, one. The argument is optional and can also take no value.

ValueDescription
oneOne SKU
few2 to 10 SKUs
lotOver 10 SKUs


<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE yml_catalog SYSTEM "shops.dtd">
<yml_catalog date="2010-04-01 17:00">
    <shop>
        ...
        <offers>
            <offer leftovers="one" ...>
                ...
            </offer>
            <offer leftovers="lot" ...>
                ...
            </offer>
            <offer ...>
                ...
            </offer>
        </offers>
    </shop>
</yml_catalog>

Form Links Between Products and Accessories

Many stores do not make enough sales to automatically form a software connection link between the product and accessories that are in highest demand.

Meanwhile, these links are available for manual creation and have probably been set by you in your personal account (regardless if you a user of one of the popular CMSs or building your own CMS).

In this case you can include these links into your XML-file to improve efficiency of "Frequently Bought Together" and "Recommended For You" recommendation blocks.

 

Specify the links in the <accessories> section:

...
<offer ...>	
	...
	<accessories>
		<!-- ID of accessory product should be specified in the 'id' parameter -->
		<accessory id="5574" />
		<accessory id="131" />
		<accessory id="99444" />
		<accessory id="334411" />
		...
	</accessories>
	...
</offer>

NOTE

Separate products listed as accessories should also be included into the XML-file. Also check they are in stock. Note that gender auto-identification does not work for such products.

Add Barcode Information

Adding this information helps you grow your sales rising relevance of product recommendations. Barcodes are useful identifiers applied in cross-comparison of your customers' interests and shopping habits.

Specify barcodes of your products in the <offer> section:

...
<offer ...>
	...
	<barcode>123456</barcode>
	...
</offer>

Check If You Use Our Niche Solutions

If you are a user of any of our Niche Solutions, please check that you added all the necessary additional parameters to your XML-file (see "Niche Solutions").

Check If You Use Our Web Push Trigger Notifications

If you are a user of REES46 Web Push Trigger Notifications, check that all images in your XML-file are in the proper format – always starting with https://

IMPORTANT

All product images starting with http:// instead of https:// won't be displayed in Web Push Notification.

 

Specify the Link to Your XML-file

Final step is to specify the link to the generated XML-file in your personal account on rees46.com (Dashboard > Settings > Store Settings)

Go to the top of the page | Go to the next guide

Table of Contents

TIP

If the XML Product Feed option is unavailable in your store due to the CMS limitations, address the HTTP API & Product Feed section.