Catalog Product Feed for Magento Adobe Commerce

Compatible with Magento v2 Adobe Commerce - Open Source (CE), Commerce on-prem (EE), and Commerce on Cloud (ECE)!

(For Magento v1 - Open Source (CE), Commerce on-prem (EE), and OpenMage LTS compatible version go to Catalog Product Feed for Magento 1 OpenMage)

Works great with Meta Pixel and Conversions API!

Works great with Pinterest Tag and Conversions API!

Works great with TikTok Pixel and Events API!

Catalog Product Feed is a very useful and efficient extension. With one button click, you can generate a catalog product feed. This feed is used for Meta Catalog (Facebook Catalog), Meta Dynamic Ads (Facebook Dynamic Ads), Meta Shopping (Facebook Shopping), Instagram Shopping, Pinterest Catalog, TikTok Catalog, and Google Shopping. Our extension has many options for customization of your product feed or feeds. Like all of our extensions, the Catalog Product Feed is multistore compatible. Every store has its product feed. Our extension also has a cron option. This allows you to fully automate the process. With our extension, you can rest assured your product feeds and catalogs are always up to date.

Meta Catalog (Facebook Catalog) is a container for all the products in your Magento store or stores. A catalog requires a product feed before you can use it in your ads. (At least one, however one catalog can have multiple feeds.)

Product Feed is a file that contains the products you want to advertise. A product feed is made up of several columns that contain information about your products, such as unique IDs, pricing, availability, and more. This product feed is used in conjunction with Dynamic Ads to automatically promote your products to people who have expressed interest in your website, in your app, or elsewhere on the Internet.

Meta Dynamic Ads (Facebook Dynamic Ads) look exactly like other single image ads or ads created in the carousel format on Facebook, Instagram, and Audience Network. However, instead of individually creating an ad for each of your products, you create an ad template that automatically uses images and details from your data feed for things you would like to advertise. Dynamic ads use your Meta Pixel (Facebook Pixel) or SDK to show ads to people who have already shown interest in your business by taking actions you care about on your site. For Meta Dynamic Ads (Facebook Dynamic Ads) to work Meta Pixel (Facebook Pixel) must be associated with Meta Catalog (Facebook Catalog) in Meta Business Suite (Facebook Business Suite).

Meta Pixel (Facebook Pixel) is a piece of JavaScript code for your website that enables you to measure, optimize and build audiences for your ad campaigns. Using the Meta Pixel (Facebook Pixel), you can leverage the actions people take on your website across devices to inform more effective advertising campaigns. If you already do not have Meta Pixel (Facebook Pixel) implemented in your Magento store check our Meta Pixel and Conversions API extension.

Meta Conversions API (Facebook Conversions API / Facebook Server-Side API) (for web) allows advertisers to send web events from their servers directly to Meta (Facebook). Server-side events are linked to a pixel and are processed like browser pixel events. This means that server-side events are used in measurement, reporting, and optimization in the same way as browser pixel events. If you already do not have Meta Conversions API (Facebook Conversions API) implemented in your Magento store check our Meta Pixel and Conversions API extension.

Just like Meta (Facebook) the Google, Pinterest, TikTok and many other companies have the similar versions of the above technologies and our extension is compatabile with them.

Compatible with Breeze frontend without the need for an additional compatibility module. It works out of the box.

Compatible with Hyvä frontend without the need for an additional compatibility module. It works out of the box.

Account & Pricing

Our extension does not require any external service nor account to function. It will generate product feeds on its own. However, product feeds generated by our extension are usually used in the following services. Accounts for these services are FREE.

• Meta Business Suite (Facebook Business Suite) account
• Instagram Business account (requires Meta Business Suite account)
• Google Merchant Center account
• Pinterest Business account
• TikTok for Business account

All of the above and probably many more use the same product feed specification. You can use product feeds generated by our extension for any or all of them.

Features

• An easy way to generate a catalog product feed or feeds.
• Product feeds generated by our extension are compatible with Google Shopping Feed.
• Product feeds generated by our extension are compatible with Pinterest Catalog.
• Works out of the box with just a button click in our extension config.
• Option to enable or disable feed generation per website and/or store view.
• Convenient option to change product feed filename.
• Support for CSV, TSV, and XML (RSS) feed formats.
• Option to include products that are not visible individually in the feed.
• Option to exclude Magento product type from the feed. One (configurable) or more (bundle,configurable,grouped).
• Option to exclude discontinued products from the feed.
• Option to exclude out of stock products from the feed.
• Option to type in arbitrary Magento product attribute code to exclude/include products from/in the feed.
• Option to type in arbitrary Magento product attribute value to exclude/include products from/in the feed.
• Option to type the attribute code you want to use for the id field.
• Option to type the attribute code you want to use for the availability field. (If left empty determination will be made based on default Magento getIsInStock() method.)
• Option to match availability values to defined ones: in stock, out of stock, preorder, available for order, and discontinued.
• Option to type the attribute code you want to use for the condition field.
• Option to match condition values to defined ones: new, refurbished, and used.
• Option to type the attribute code you want to use for the description field. (The fallback mechanism is in place if an attribute value is empty. Priority is your_attribute > meta_description > short_description > description > product name.)
• Option to use parent product data for description field.
• Option to type the attribute code you want to use for the rich_text_description field.
• Option to use parent product data for rich_text_description field.
• The image_link field will be populated automatically. (If a product does not have an image, the extension will try to get a parent product image.)
• The link field will be populated automatically.
• Option to type the attribute code you want to use for the title field. (The fallback mechanism is in place if an attribute value is empty. Priority is your_attribute > product name)
• Option to use parent product data for title field.
• The price field will be populated automatically.
• Option to type the attribute code you want to use for the gtin (Global Trade Item Number) field.
• Option to type the attribute code you want to use for the mpn (Manufacturer Part Number) field.
• Option to type the attribute code you want to use for the brand field.
• Option to type default text for the brand field. (It is used if an attribute is empty.)
• Option to enable identifier_exists field.
• Option to enable override field.
• Option to select country or locale for override field.
• Option to type the field name you want to use for the inventory.
• Option to type limit for the additional_image_link field. (Empty or 0 (zero) means disabled. Any number from 1 to 10 means enabled. The number represents a limit for additional images.)
• Option to type the attribute code you want to use for the age_group field.
• Option to match age_group values to defined ones: adult, all ages, teen, kids, toddler, infant, and newborn.
• Option to type the attribute code you want to use for the expiration_date field.
• Option to type the attribute code you want to use for the gender field.
• Option to match gender values to defined ones: male, female, and unisex.
• Option to type the attribute code you want to use for the item_group_id field.
• Option to type the attribute code you want to use for the product_type field.
• Option to type default category for the product_type field. (It is used if an attribute is empty.)
• Option to type the attribute code you want to use for the fb_product_category field.
• Option to type default category for the fb_product_category field. (It is used if an attribute is empty.)
• Option to type the attribute code you want to use for the google_product_category field.
• Option to type default category for the google_product_category field. (It is used if an attribute is empty.)
• Option to enable the sale_price field in the feed.
• Option to enable the sale_price_effective_date field in the feed.
• Options for product_length, product_width, product_height, product_weight, shipping, shipping_label, ships_from_country, shipping_length, shipping_width, shipping_height, and shipping_weight fields and additional options for default units and default values.
• Option for additional fields to attributes mapping. Example: color=color|material=material|pattern=pattern. As you can see the format is simple field1=attribute1|field2=attribute2 The feed field and Magento product attribute are connected by = sign and pairs are separated by | sign.
• For full automation, our extension provides a cron option so your product feed or feeds can always be up to date.
• Cron expression option for product feed generation so you can choose the time and frequency of feed regeneration.

Installation Instructions

There are several ways you can install any Magento extension. Our extension is no different. We will show you four ways to install the extension, but you must not mix them. Choose one and stick to it.

If you do not know how to install an extension or you wish a professional to do it for you, we offer additional installation service for a small fee.

Installation via file uploading
(If you purchased the extension on our site)

If you purchased the extension on our site then unpack .zip file from /Magento2/InstallByUploadingFiles/ directory inside your Magento root.
- Run following commands on Magento root directory:

php bin/magento maintenance:enable

php bin/magento module:enable --clear-static-content Apptrian_CatalogFeed

php bin/magento setup:upgrade

php bin/magento cache:flush

php bin/magento setup:static-content:deploy

php bin/magento maintenance:disable

php bin/magento cache:flush

Installation via Composer
(If you purchased the extension on our site)

If you purchased the extension on our site and you want to install the extension via composer public and private keys. (To find your public and private keys, login to your Apptrian.com customer account and look at the My Downloadable Products section.)
- Run following commands on Magento root directory:

php bin/magento maintenance:enable

composer config --auth http-basic.packages.apptrian.com $PUBLIC_KEY $PRIVATE_KEY

composer config repositories.apptrian-catalog-product-feed composer https://packages.apptrian.com/catalog-product-feed/

composer require apptrian/catalog-product-feed

php bin/magento module:enable --clear-static-content Apptrian_CatalogFeed

php bin/magento setup:upgrade

php bin/magento cache:flush

php bin/magento setup:static-content:deploy

php bin/magento maintenance:disable

php bin/magento cache:flush

Installation via Composer by using artifact
(If you purchased the extension on our site)

If you purchased the extension on our site then copy .zip file from /Magento2/InstallWithComposer/ directory inside your MAGENTO_ROOT/vendor/apptrian/packages/ directory (create directory if does not exist).
- Run following commands on Magento root directory:

php bin/magento maintenance:enable

composer config repositories.apptrianartifacts artifact $(pwd)/vendor/apptrian/packages

composer require apptrian/catalog-product-feed

php bin/magento module:enable --clear-static-content Apptrian_CatalogFeed

php bin/magento setup:upgrade

php bin/magento cache:flush

php bin/magento setup:static-content:deploy

php bin/magento maintenance:disable

php bin/magento cache:flush

Installation via Composer
(If you purchased the extension on Magento Marketplace)

If you purchased the extension on Magento Marketplace then you must use Composer. Magento Marketplace does not allow extension downloads.
- Run following commands on Magento root directory:

php bin/magento maintenance:enable

composer require apptrian/catalog-product-feed

php bin/magento module:enable --clear-static-content Apptrian_CatalogFeed

php bin/magento setup:upgrade

php bin/magento cache:flush

php bin/magento setup:static-content:deploy

php bin/magento maintenance:disable

php bin/magento cache:flush

Please make sure your Magento public and private keys are in your Magento root auth.json file. Usually, people install Magento with one Magento Marketplace account (public and private keys) and then purchase an extension with another Magento Marketplace account (different public and private keys). Check the Magento Marketplace account you used to purchase the extension and make sure its public and private keys are in the Magento root auth.json file. WARNING! if you already have keys there, be very careful because maybe some other extensions are purchased with another Magento Marketplace account.

Configuration

Our extension works out of the box. The only thing you need to do is click the "Generate Product Feed" button in our extension configuration. To do this log to your Magento Admin and go to:

Stores > Configuration > Apptrian Extensions > Catalog Product Feed

We recommend you to type in the "Default Brand" option since this field is required in the product feed. Our extension will try to get product brand attribute first, but you might not have a brand attribute for your products or some of your products might have an empty value for it.

google_product_category

Optional but recommended for dynamic ads (may contribute to improved ad performance). Optional for Instagram Shopping and Page shops, but required to enable onsite checkout on these channels (the US only). Required for Marketplace (the US only).

We recommend you to check the "For google_product_category Use" option and type the Magento product attribute code you want to use for the product feed google_product_category field. Although this field is optional it is recommended that you use it. The field value is one of the predefined values (string or category ID) from Google's product taxonomy. For example, Apparel & Accessories > Clothing > Dresses or 2271.

We recommend you to type in the "Default google_product_category" option. Our extension will try to get the product google_product_category attribute first, but you might not have a google_product_category attribute for your products or some of your products might have an empty value for it.

fb_product_category

This field is optional. If you do not want it, make the "For fb_product_category Use" option empty.

The Facebook product category represents the item according to the Facebook product taxonomy. This taxonomy organizes products for sale into categories and subcategories. For example, Health & Beauty > Beauty > Makeup > Eye Makeup > Mascara.

We recommend you to check the "For fb_product_category Use" option and type the Magento product attribute code you want to use for the product feed fb_product_category field. The field value is one of the predefined values (string or category ID) from Facebook's product taxonomy. For example, Health & Beauty > Beauty > Makeup > Eye Makeup > Mascara or 281.

We recommend you to type in the "Default fb_product_category" option. Our extension will try to get the product fb_product_category attribute first, but you might not have a fb_product_category attribute for your products or some of your products might have an empty value for it.

product_type

This field is optional. If you do not want it, make the "For product_type Use" option empty.

Optional for dynamic ads and commerce. Max character limit: 750. Category the item belongs to according to your business's product categorization system if you have one. For commerce, represents the product category in your internal system. Example: Home & Garden > Kitchen & Dining > Appliances > Refrigerators

We recommend you to check the "For product_type Use" option and type the Magento product attribute code you want to use for the product feed product_type field.

We recommend you to type in the "Default product_type" option. Our extension will try to get the product product_category attribute first, but you might not have a product_category attribute for your products or some of your products might have an empty value for it.

After generation is done you are ready to tell Meta (Facebook) about your Catalog Product Feed. This is done in Meta Business Suite (Facebook Business Suite) and there you have two ways to add product feed to your catalog.

Set a Schedule or Upload Once

* See screenshot 3.

If you decide to go with "Set a Schedule" this means Meta (Facebook) will regularly check your feed URL for new products and changes making your catalog up to date automatically.

If you decide to go with "Upload Once" this means you will upload feed file every time you want to update your catalog.

You can use any approach you want.

There are several options for product feed customization. They are all self-explanatory and have comments and tooltips.

After changing options make sure you refresh your Magento cache and then regenerate the feed by clicking "Generate Product Feed" button.

FAQ

Q: After I replaced the old Facebook Catalog Product Feed extension with the new Catalog Product Feed extension, it seems the new extension does not work?
A: If you replaced any previous version with version 2.0.0 or newer, please check the new extension config in Magento admin because settings from the old extension will not be transferred automatically.
Stores > Configuration > Apptrian Extensions > Catalog Product Feed

Q: Can I change product feed filename?
A: Yes you can. There is a convenient option in our extension config. It is called "Product Feed File Name" in order to see this option you need to change the scope to Store View. If you have two or multiple stores be aware that file name must be unique. This means two or more stores must not have the same file name.

Q: Which "Product Feed Format" should I use?
A: Well by default we set CSV but you can use any format you like. Be aware that XML-RSS format is an XML that means there is an overhead of tags so XML-RSS product feed will produce larger file than CSV or TSV.

Q: After the extension update age_group field does not work properly?
A: If you updated the extension from some older version to v1.7.0 or newer you need to remap values in the age_group Map option because new options are added, and the sort order is changed to adult, all ages, teen, kids, toddler, infant, and newborn.

Q: After the extension update feed does not generate?
A: If you updated the extension from some older version to v1.7.0 or newer, you need to make sure the Additional Fields to Attributes Mapping option does not include any reference to product_type nor fb_product_category. These fields have dedicated options in the new versions of the extension.

Q: Why are product and shipping fields empty?
A: By default, these fields are not configured. You need to configure these fields in our extension config. Also, if you do not have Magento product attributes for these fields you need to create them in Magento admin and type in the values for each product. The dimensions and weight values should be numerical without units and then you can set default units in our extension config. If you already have values with units our extension will not add the unit at the end. Please read the tooltips of each option for more information.