"Advanced Product Export (xml and csv formats)" documentation

Offers an alternative to the built-in CS-Cart mechanism for working with custom product feeds, the essence of which is to create configurable templates (which defines the format for its construction) and create separate feeds that can use previously created templates as well as flexible conditions (criteria) for adding products in it.

Supports xml, csv, yml, txt feeds formats;
Ability to pre-prepare the feed file (using scheduled CRON tasks);
The ability to upload "on the fly" (the product feed file will be generated before trying to download it - it is in demand if the task is to always return only the most relevant data);
Possibility to add start product feeds template based on the built-in so-called Standard template (uses typical data (fields) of product feeds);
The ability to edit the template without the need to edit the file code (only an understanding of the basics of Smarty is required);
Ability to create a product feed template based on fields from additional addons (see the Integration with other addons section);
Possibility of extending by addons of templates by their custom fields (in this case, development by the user’s addon or by third-party developers is necessary);
The ability to create an unlimited number of individual product feeds based on previously created templates with their own settings and criteria for adding products;
Ability to determine the name of the feed file;
Ability to create feeds for the desired language (from installed in the store);
The ability to determine the Brand feature in feed;
Ability to choose the currency for feed;
The ability to limit the number of images of products used in feed;
Ability to use uploaded images - originals or prepared by CS-Cart thumbnails used in the product card;
The ability to work with products - variations in feeds;
The ability to upload product prices, taking into account promotions with the type For catalog;
The ability to automatically start the formation of the feed according to the fulfilled condition (action, for example, immediately after the exchange with the accounting system has worked);
The ability to determine whether to display the feed file on the screen or download the file when switching to the address of the finished upload;
Ability to set authorization for access to the file of each upload (by the login - password pair configured for each file);
The ability to specify the criteria for products to be added in feed by price (range), availability (only in stock or all), state of the product description (only with a completed description or all), presence of completed product images (only with an image or all), filter with Stop - words (in the fields: Product name, Short description, Detailed description, Keywords);
The ability to specify product quantity as a criterion for the inclusion of products in the feed;
The ability to specify as a criterion for the inclusion of products in the feed of conformity product category;
The ability to specify product features as a criterion for including products in feed;
The ability to specify Manually as the criterion for including products in feed (only necessary products for inclusion);
The ability to specify as a criterion for exclusion of products from some category from the feed;
The ability to specify as a criterion for exclusion of products from feed by filling Manually (only products necessary for exclusion);
The ability to use additional parameters for unloads added by third party addons (including can be extended by custom development).

For CS-Cart Multi-Vendor edition:

Administrator can create individual product feeds for a specific vendor and storefront (for Multi-Vendor Ultimate).

Integrations for add-ons (ready feeds + analytics pixels):

Compatibility

Available add-on version	CS-Cart/Multi-Vendor compatible versions
`v3.12.0`	4.13.1 – 4.17.2
`v3.7.2`	4.10.1 – 4.10.4
`v3.5.1`	4.3.3 – 4.9.3

Add-on is compatible with the following Themes:

YoupiTheme (compatible with correspond CS-Cart version);
UniTheme2 (compatible with correspond CS-Cart version);
Responsive.

Support

General technical support conditions are available at this link (be sure to review these conditions, all solutions from the AlexBranding development team come with limited technical support).

In order to use our technical support, you need to:

Log in with your order owner account on https://cs-cart.alexbranding.com;
Go to the page My Account → Orders;
Find the corresponding order with the problem add-on in the orders list and pass to its details;
Find the “Support” link next to the corresponding add-on name (near you can find Documentation link also) and click on it;
Fill in the data with the problem, provide access to your CS-Cart installation (path to the administration panel, admin mail, admin password + FTP access) and create a ticket (after you will create the ticket, you will receive an e-mail and a special code to track the ticket in the future);
Wait for the specialist answer in accordance with the regulations of the technical support service and the priority of your ticket.

If you didn't receive an answer within the deadlines, according to the chosen ticket priority, send e-mail info@alexbranding.com with the ticket number, for which you did not receive an answer in time, and the team manager will solve the problem in compliance with regulations.

Technical support by telephone calls and direct e-mails is not provided. Any help comes through tickets and helpdesk. Carefully learn documentation and technical support conditions before creating a request.

Demo

You can test the addon work with admin access using our demo server Demos for CS-Cart solutions from Alexbranding by choosing it in Addons list or just follow the link.

Restrictions and warnings

We recommend to note general restrictions:

All solutions from AlexBranding developers team require pre-installation of the AB: Addons Manager service addon. It is delivered free of charge and is responsible for such services: installation, upgrades, license verifications. Excluding this service addon usage is not possible;
Addon files may have a closed (encoded) part, in which only a license check is located;
The addon will work only on those domains, that are specified in the user's license. If you try to use the solution on CS-Cart installations, whose domains are not included in the license, the addon will be automatically turned off;
Local installation is not possible, so that the addon works on the additional domain (subdomain), enter this domain (subdomain) in the Domain field, when ordering (or write to info@alexbranding.com) - adding technical domains for the developing or for testing is always free.

Usage

Installation

After your order has been processed by our manager, it will be transferred to Completed state, you will receive an email to your mailbox with ordered add-ons license numbers (usually it takes from 15 minutes to 8 hours depending on the day time and week day).

Then follow the steps below, which differs depending on your version of the CS-Cart platform:

If you have CS-Cart 4.16.1 and newer version

If you have CS-Cart 4.13.1 and newer version

If you have CS-Cart 4.12. *

If you have CS-Cart 4.11.5 and an earlier version

You can also install the add-on with a standard installation for CS-Cart. To do this, download the appropriate archive with an add-on version compatible with your version of the CS-Cart platform.
Go to the website cs-cart.alexbranding.com, log in under the account of the order holder and go to the page My Profile → Orders → Relevant Order, go to details and you will see a list of available archives for the ordered add-on. Download the version (archive) you need and make the installation (standard for CS-Cart installation: Add-ons → Downloaded add-ons and in the gearwheel menu select Manual installation).

Service add-on AB: Add-ons Manager must be installed and have Active status.

Work with functionality

1. Template creation

2. Feed creation

3. Feed file generating

4. Feeds files autogeneration

5. Access restrictions

6. Use language code at product URL

The sl parameter with the language code from the "Language" setting will be used at the product URL.
It allows a client to open a product page in the language specified in the feed.

This setting works only at the case when the setting Use single URL for all languages from CS-Cart add-on SEO is active.

Example to use the setting "Use language code at product URL"

7. Use currency code at product URL

The currency parameter with the currency code from the Currency setting will be used at the product URL. It allows a client to open a product page with the currency specified in the feed.

Example to use the setting "Use currency code at product URL"

8. Choosed feature in feed

9. Additional field for feed

10. Export variations

11. Apply promotions

12. Water mark

13. Features names replacement

14. Additional information

15. Problem resolving

Impossible to remove the addon

404 server error

Feed file generation lagging

If at feed generation start you see message like

The generation of datafeed started 01/01/2020 12:00. Loaded 200 from 300 products

it means, feed generation is not completed. If the feed products number does not change when the window is updating, the generation is likely stuck. You can reset it by pressing Reset feed generation gear.

Feed generation reset

Integrations

1. Provide feed template for Hotline store

Relevant for add-ons:

Add-on Advanced Product Export (xml and csv formats) is a mandatory for work of the CS-Cart Hotline xml export add-on. It provides a feed template to make a product feed. The add-on CS-Cart Hotline xml export cannot work alone.

2. Provide feed template for Prom store

Relevant for add-ons:

Add-on Advanced Product Export (xml and csv formats) is a mandatory for work of the Prom.ua product export xml feed add-on. It provides a feed template to make a product feed. The add-on Prom.ua product export xml feed cannot work alone.

3. Provide feed template for Nadavi (E-katalog) store

Relevant for add-ons:

Add-on Advanced Product Export (xml and csv formats) is a mandatory for work of the Nadavi product export xml feed add-on. It provides a feed template to make a product feed. The add-on Nadavi product export xml feed cannot work alone.

4. Provide feed template for Google remarketing store

Relevant for add-ons:

Add-on Advanced Product Export (xml and csv formats) is a mandatory for work of the Google dynamic remarketing + merchant center add-on. It provides a feed template to make a product feed. The add-on Google dynamic remarketing + merchant center cannot work alone.

5. Provide feed template for Facebook store

Relevant for add-ons:

Add-on Advanced Product Export (xml and csv formats) is a mandatory for work of the Dynamic Facebook and Instagram ads (pixel + product feed) add-on. It provides a feed template to make a product feed. The add-on Dynamic Facebook and Instagram ads (pixel + product feed) cannot work alone.

6. Provide feed template for Mytarget remarketing store

Relevant for add-ons:

Add-on Advanced Product Export (xml and csv formats) is a mandatory for work of the MyTarget remarketing for Mail.ru add-on. It provides a feed template to make a product feed. The add-on MyTarget remarketing for Mail.ru cannot work alone.

7. Provide feed template for Rozetka store

Relevant for add-ons:

Add-on Advanced Product Export (xml and csv formats) is a mandatory for work of the Product feed for ROZETKA.ua add-on. It provides a feed template to make a product feed. The add-on Product feed for ROZETKA.ua cannot work alone.

8. Provide feed template for PrivatMarket store

Relevant for add-ons:

Add-on Advanced Product Export (xml and csv formats) is a mandatory for work of the Product feed for Privatmarket add-on. It provides a feed template to make a product feed. The add-on Product feed for Privatmarket cannot work alone.

9. Provide feed template for Yandex store

Relevant for add-ons:

Add-on Advanced Product Export (xml and csv formats) is a mandatory for work of the Yandex Market product feed add-on. It provides a feed template to make a product feed. The add-on Yandex Market product feed cannot work alone.

10. Provide feed template for Multisearch store

Relevant for add-ons:

Smart search from multisearch.io
Advanced Product Export (xml and csv formats)Минимальная версия: 3.9.4

Add-on Advanced Product Export (xml and csv formats) is a mandatory for work of the Smart search from multisearch.io add-on. It provides a feed template to make a product feed. The add-on Smart search from multisearch.io cannot work alone.

11. Use additional variables in feed templates

Relevant for add-ons:

Additional variables are available for using in templates.

PHP-hook(s) in add-on

ab__pfe_get_items_after_table_fill

/**
  * Allows to modify values in temporary table
  *
  * @param array  $datafeed        Datafeed data
  * @param array  $params           Params from template
  * @param string $table_name   Database table name
  */
fn_set_hook('ab__pfe_get_items_after_table_fill', $datafeed, $params, $table_name);

How to update

To have possibility to update an add-on, you must have an active subscription period for add-on license.

AB: Add-ons Manager will notify you about available updates (you will see an indicator of new alerts). The recommended way is to update via the CS-Cart Upgrade center (a regular procedure of the platform). This method will allow lossless configuration of the transition to the new add-on version, that is guaranteed to be compatible with your CS-Cart platform version.

Before updating, always make a full database and your store files backup (we recommend backing up using server or hosting tools).

To make updates procedure:

Go to the Administration panel → Administration → Upgrade center;
Find the appropriate update among the available updates and click the Update button;
Follow all the instructions, that will be shown during the upgrade procedure;
Clear CS-Cart cache and start using new add-on version.

If you have an earlier version of the add-on (without the Upgrade center support)

FAQ

How to exclude a feature

Example to exclude features:

{if $product.features}
{foreach $product.features as $feature}
    {* не выводить часть хар-к *}
    {if !in_array($feature_id, [2662,2661])}
        <param name="{$feature.name}">{$feature.value}</param>
    {/if}
{/foreach}
{/if}

List of releases

Subscribe to our Telegram-channel to get info about new releases.

v3.12.0 from 27 April 2023

New features and improvements:
[+] Multi-Vendor edition. Added a new setting “Common products” on the page of feed settings in the tab “Data selection conditions”.

Bug fixes:
[!] Multi-Vendor edition. Products of disabled and temporary stopped vendors were fed. Fixed.
[!] On the editing feed page the button “Add condition” have not been working in the tab “Include data objects”. Fixed.

v3.11.1 from 27 December 2022

Bug fixes:
[!] "Warehouses" add-on. In the multi-store PHP error has occured on the tab "Conditions of data selection" when the setting "In stock only" and the add-on "Warehouses" was installed. Fixed.

v3.11.0 from 27 December 2022

Attention! If you use the field «p.amount» in the templates, then you have to change it on «amount» (for extra_fields, extra_join, extra_condition).

New features and improvements:
[+] Added support of the "Warehouses" add-on.
[+] Added a new setting "Use currency code at product URL" on the datafeed page.
[+] Added a new setting "Use language code at product URL" on the datafeed page.

Functionality changes:
[*] For multi stores added a feed of the first category in product list, if an appropriaate product has a main category that is linked to the other store.

Bug fixes:
[!] On the template page useless horizontal scroll has appeared. Fixed.

v3.10.0 from 23 June 2022

Bug fixes:
[!] On the page "Feeds list → [feed name] → "Include data objects" tab" features could not be saved when selecting the condition "in". Fixed.

v3.9.4 from 22 Jule 2021

Bug fixes:
[!] On products selection by brand only (without categories or products conditions) there wasn't element in the datafeed file. Fixed.

v3.9.3 from 22 Jule 2021

Bug fixes:
[!] There were other products from the categories of manually added products in the datafeed file, when using "OR" value of "Scheme of combining of products selection conditions". Fixed.

v3.9.2 from 20 Jule 2021

Bug fixes:
[!] When exporting separate products, their categories weren't included into the general array of categories in datafeed template. Fixed.

v3.9.1 from 19 May 2021

Bug fixes:
[!] When generating datafeed with setting "Images quantity" value equals 0, error occurred. Fixed.

v3.9.0 from 19 May 2021

Running Cron-task by http-link has been disabled. If you have used such format, change Cron-task into a running console command.

New features and improvements:
[+] Added datafeed setting "Scheme of combining of products selection conditions" in the tab "Include data objects", which allows to set products selection more flexible.

Functionality changes:
[*] Removed the add-on setting "Cron-key". Cron task can be executed at console mode only.

Bug fixes:
[!] Multi-Vendor edition. In the dialog window of selected or excluded products, vendors' products weren't displayed. Fixed.
[!] Ultimate edition. When generating datafeed file with unchecked setting "Full-size images", links of images were specified with the address of the default storefront, instead of the chosen one. Fixed.
[!] On the place of feature name in a datafeed file were put names of disabled filters.

v3.8.0 from 19 January 2021

Release video:

Attention! The new version of the add-on is not compatible with old templates. After add-on update, you have to update all dependent add-ons and their templates.

New features and improvements:
[+] Added compatibility with CS-Cart 4.12.1.
[+] Added progress bar for manual start of datafeed generating from the administrative panel.
[+] Added displaying of the last generating date of the file on the page of datafeeds list.
[+] Pages of the add-on in administrative panel are adapted for mobile devices.
[+] Added autogenerating of the Cron-key, when installing the add-on.
[+] In datafeed settings added product selection conditions by amount.
[+] On the datafeed editing page added link to edit the chosen template.
[+] On pages for managing templates and datafeeds added extra navigation menu.
[+] Multi-Vendor Ultimate edition. Added compatibility.
[+] Multi-Vendor edition. Added condition for product selection by vendor.
[+] Added ability to generate datafeed "on the fly".

Functionality changes:
[*] Queries were optimized for datafeed generating with a big amount of products.

Bug fixes:
[!] Ultimate edition. Product name on different storefronts, if different names were set for different stores, has been displayed incorrectly in some cases. Fixed.

v3.7.3 from 01 October 2020

New features and improvements:
[+] Added PHP hook "ab__pfe_get_items_after_table_fill".
[+] Added Ukrainian language support.

Bug fixes:
[!] SQL errors could occur when adding fields from tables connected by user. Fixed.
[!] Ultimate. Links for Cron tasks were specified excluding storefronts.
[!] Links to products of datafeed's file were always generated on the storefront language by default. Fixed.
[!] Datafeed's file left available even after feed disable. Fixed.

v3.7.2 from 05 December 2019

Functionality changes:
[*] Updated usergroups privileges.

Bug fixes:
[!] On multi-store site product links in a datafeed were incorrect. Fixed.
[!] Stucked datafeed generation didn't reset on cron. Fixed.
[!] On datafeed with features condition generated product variation (as one product) didn't load. Fixed.

v3.7.1 from 13 November 2019

Functionality changes:
[*] Attribute group_id was added into the template "General".

Bug fixes:
[!] When the option "Export variations" is enabled, field variation_group_id wasn't loaded. Fixed.

v3.7.0 from 27 September 2019

New features and improvements:
[+] Added the ability to install the demo data with all products list.

Functionality changes:
[*] Option "Export variations" work logic is changed.

Bug fixes:
[!] An error occurred at deleting the category. Fixed.

v3.6.0 from 23 June 2019

Feature changes:
[*] Variations export is adapted to cs-cart 4.10.2

v3.5.1 from 10 June 2019

Bug fixes:
! fixed bug with empty company_id on ultimate;

v3.5.0 from 05 April 2019

Feature additions:
[+] added ability to include single products;

Bug fixes:
[!] fixed notice on datafeed delete;
[!] fixed error with last product key;
[!] fixed issue with wrong link (if SEO addon is deactivated);