Skip to main content

Product Feed

Product Feed

Overview​​

If customers sell their products on a variety of channels such as Google Shopping, Ebay, Amazon, etc and these channels use the same database, then they can automatically update their items by importing the exported data files from the original channels. Thanks to this, store owners can save more time and manage their sales channels with ease. That's also an awesome feature from Mageplaza Product Feed extension.

Outstanding Features​

Outstanding featuresDescription
Customize Feed templatesApart from 5 default feed templates ( XML, TXT, CSV, XLS, TSV), users can increase the variety of their website by self-customizing their own templates. This aims to find the most suitable template for your website's content as well as attract more visitors.
Synchronize products with Google Shopping API, Facebook APITo reduce the workload, this module supports synchronizing the products to GG shopping API as well as Facebook API. This also helps to reach out to more potential customers and enhance the revenue of your store.
Filtering and displayingNot only support admin filtering products based on attributes, but admin also can set the limitation for products.
Mapping categoriesAssist admins in arranging delivery times, checking change logs, and importing category maps for products
Product Feed Revenue ReportThis feature helps admins monitor website performance through reporting charts (column and pie), and clearly understand the operating situation of the entire store.

Installation​

We offer two methods for installing our plugins: the Copy & Paste method and the Composer method. Please follow the detailed instructions provided below.

Method 1: Installation via Copy & Paste​

To install our plugins using the Copy & Paste method, kindly follow the instructions at the link below:

How to Install Magento 2 Extension via Copy & Paste

Method 2: Installation via Composer​

Composer name: mageplaza/module-product-feed

To install our extensions using Composer, please refer to the comprehensive guide at the link below:

How to Install Magento Extension via Composer

By following these guides, you can ensure that the installation process is handled correctly, allowing you to fully utilize the features and benefits of our plugins.

Module Update Guide​

Keeping your module updated ensures optimal performance. Follow one of these steps to update your module:

  1. By Account Dashboard: Log in to your Mageplaza account > go to the My Licenses section > click on the Download button > choose the latest version from the popup.

  2. By composer: Kindly use the following commands to update the module via composer

composer require mageplaza/mageplaza/module-product-feed
php bin/magento setup:upgrade
php bin/magento setup:di:compile

Updating a module by Composer ensures efficient dependency management, version control, and integration with development tools, making the process faster and more reliable.

How to configure​

From the Admin Panel, go to Store > Settings > Configuration > Mageplaza Extensions > Product Feed > Configuration

Configuration​

From the Admin Panel, go to Products > Product Feed > Configuration, choose General section

General​

  • Enable: Choose "Yes" to use this module
  • Categories Path for Product URLs: Create the URL for the product. If select Default, the URl will be generated as the default Magento (Category with the smallest ID).
    • Note: Categories Path is only correct when setting Use Categories Path for Product URLs = Yes

  • Clean Log Every: Select the number of days to clean the created logs at Feed Log after the selected time. If empty or zero, the log will not be cleaned.

Google Shopping API​

This aims to guide users on how to synchronize the products from their websites to GG shopping API as well as Facebook API. The detailed instructions as below:

How to set up

  • Register an account of Google Shopping API and go to this link.
  • After your account has been registered, you will see the value in the field Merchant ID. Save that Merchant ID value to connect with your website later.

  • Go to this link to get the information of Google Shopping API: Client ID and Client Secret connect with your website. Click on Create Credentials > OAuth client ID.

  • With the field Application type, you can choose Web application, enter the information like Name. Copy and paste the value of the field Authorized Redirect URIs of your website in the field Authorized Redirect URIs of Google Shopping API. Then click Create button to complete.

  • Select Ok to complete creating OAuth client ID. Save the Client ID and Client Secret to connect with your website.

  • In the Google Cloud Console, go to APIs & Services > Library and enable Merchant API in the Google Cloud project of your OAuth client.
  • The Google account used for Get Access Token needs Admin access to your Merchant Center account, and the Merchant Center account needs a verified website.

Google Shopping API

  • Enable: Choose Yes to synchronize the value with Google Shopping API
  • Send data every: Select the number of days in the Send data every field (0-28). After the selected number of days, the feed data will be synced to Google Shopping API. Google expires products that are not sent again within 30 days. 0 = every day. Note that this feature is only applied to sync via cron.
  • Merchant ID, Client ID, Client Secret: Enter the value of the fields you have already saved and set up here.
  • Authorized Redirect URIs: Copy and paste the value of this section in the Authorized Redirect URIs of Google Shopping API.
  • Click Get Access Token button to connect with Google Shopping API.

How the sync works​

Products are synced to Google through the Google Merchant API.

  • Data source: The module registers with the Merchant API automatically at the first sync. Each feed has its own data source.
  • Country and language: The Country of sale and Language of the feed are checked when you save the feed.
  • Error file: Products rejected by Google are written to an error file.
  • Email: Select Google Sync Successfully and Google Sync Error in the When field of Email Alert to receive the sync result by email.
  • Removed products: Products that have left the feed are deleted from the Merchant Center of that feed.
  • Upgrade notice: After upgrading, a notification in the admin panel guides you to switch to the Merchant API.

Facebook API​​

The purpose of this configuration is the same as that of GG shopping API

  • Enable: Select Yes to sync the value to Facebook API.
  • Send data every: This is the part that automatically syncs Facebook feed data from the customer's website to the Facebook page. It will automatically sync after the selected time. The default time is 00:00. After syncing the facebook feed to the facebook page, the time will be fixed at 3:00 a.m to synchronize data from the feed on the facebook page to the item.
  • App ID, App secret, Authorized Redirect URIs

How to configure Facebook API:

    1. Head to the Facebook Developers portal https://developers.facebook.com/apps and log in using your Facebook credentials.
    1. Login Facebook by click on Login or Create a new Facebook account. After that, click on My App from the Apps menu at the top, then click Create Apps to create your new app

    1. Then, redirect to the app creation page. Fill out Display name, Email for your app

    1. Next, at page Basic, enter the url in App Domains, Site URL and URL Privacy Policy fields. They should match with the current hostname example.com. Here, get information from the App ID and App Secret fields to enter into the Facebook Api section on your website

    1. Click Add platform to add Site URL.

    1. On the Advanced page, get the Authorized Redirect URIs from our Product Feed settings in the backend

    1. Click Add product from the navigation bar to perform Facebook setup. As the Step 5, at Facebook Login > Settings: copy Authorized Redirect URIs and paste in the Share Redirect Domain Allow List field.
    1. Add Permissions & Verification by going to App Review and select Permissions and Features
    1. Access to the Basic page, get, and insert APIs into API fields in the extension's settings in the Admin console.

And that's it!

If, for some reason, you still can't manage to create an application for Facebook, you can ask for support

Catalog ID

    1. Go to Commerce Manager.
    1. Use the drop-down menu in the left-hand menu to select your business portfolio. Then, use the second drop-down menu to select the shop that you want to use in your ad.

Note: If you do not see the second drop-down menu, you may need to first select your commerce account. You can do this under Assets.

    1. With your shop selected, click Settings in the left-hand menu.
    1. Click Catalogue.
    1. Your catalogue details will appear under Catalogue name.

Email Alert​

Enable Email Alert means that every action is made, and there will be a notification sent to the specified emails. There can be 1 or many actions, depending on the need of admins.

  • Enable: Choose "Yes" to enable the email notification for store owners

  • Send to:

    • Enter the email to send the notification
    • Allow entering multiple emails. These emails are separated by commas.
  • When:

    • Choose the events that when it happens, the email notification will be sent
    • Be able to choose many events at once

Report​

The Report section is now separated from Manage Feeds into a new title. From the Report, the admin can follow all the created feeds with the most basic information such as name, status, etc.

  • From the Admin Panel, go to Catalog > Product Feeds > Report

  • This is where all created feeds are displayed.

  • Here admins can have basic information of the feed such as: ID, Name, Status, File Type, Execution Mode, Store, Action, Click, Impression, CTR,...

  • Admins can select Action if they want to Delete, Generate, or Change Status Feed.

  • Besides that, admins can also Filter, Export, Hide/Show the Columns

  • Note: CTR (Click through rate)= (Click/ Impression) * 100%

    • Click: the number of clicks in the product link uploaded to the app or the feed file
    • Impression: the number of views of the product link uploaded to the app or the feed file
  • Sync Facebook including:

    • Sync Manual: Only sync Facebook when the feed file has been generated

Product Feed Revenue Report​

The Revenue Report is based on the statistics of the ordered products uploaded to the feed file or the app. The pie and column charts shown are the results of the Total Revenue field, with the top 20 feeds with the highest revenue. This helps the admin manage the website’s productivity.

Report information includes:

  • Pie and column charts including Revenue statistic and CTR statistics

  • Grid includes: pagination, filter, export, information on ID, name columns,...

Note: Total Revenue and Refunded do not include the shipping fee.

  • Visits are still counted when full-page cache is enabled.
  • Revenue is calculated by order, and refunds are handled.

How to create New Feed​

  • Step 1: Enter full information of General field
  • Step 2: Choose Template type
  • Step 3: Enter full information of Google Analytics
  • Step 4: Choose the condition to export the file
  • Step 5: Enter the Category Map for products
  • Step 6: Setup the method to send the exported file
  • Step 7: Check the update history of the exported file
Step 1: Enter full information of General field​
  • From the Admin Panel, go to Products > Catalog > Product Feed > Manage Feeds

  • In the right corner, choose Add New Feed button

  • Name: Enter the display name in the Grid Feed for the export type

  • Status: Choose Enable to auto-update the products when running cron

  • Store Views: Choose the store to get that store’s product and generate the file

  • File Name: Enter the export file name to send to the server

  • Compress File: Choose the format to compress the file: None, Zip, Gz or Bz. The compressed file can be downloaded and delivered.

    • Note: The Rar option has been removed. Feeds that were set to Rar are changed to Zip when you upgrade.

  • Generate Config: Choose the export type

    • Execution Mode = Manual: Allow generating the file manually

    • Execution Mode = Cron: Auto-generate the file, depend Frequency & Cron Run Time field

      • Frequency = Daily: Auto-generate the file daily
      • Frequency = Weekly: Auto-generate the file weekly
      • Frequency = Monthly: Auto-generate the file monthly
      • Cron Run Time: Setup the time to auto-generate the file at the time that you have setup. Please note that the time is evaluated in the timezone of the store of the feed. Each feed runs on its own schedule, and a feed that fails does not stop the other feeds

Step 2: Choose Template type​
  • Template is updated with Bing Ads CSV, Facebook XML, TSV, XLSX

  • Select the template format to export the file. The available templates are: Google Shopping, Google Shopping Review, Amazon Inventory, Amazon Marketplace, Facebook, Ebay, Bing Ads, ChatGPT (OpenAI) and you can choose Custom to customize as your preference.
  • ChatGPT (OpenAI) Beta: A TSV file with 34 columns, with its own validator and the Gz compression preset. See ChatGPT (OpenAI) Feed.

  • Google Shopping Review: The review feed is checked against the Google standard. After the feed is generated, the Validation Report is shown on the edit page of the feed, where you can download it as a CSV file.

  • After selecting the Default Template, it will depend on File Types including: TXT, CSV, and XML, TSV, XLS

  • Click on the Load Template button to display the template content

  • For the template format is XML:

    • Template content: The template content is displayed in this field. Admins can edit the template content here.
    • Add the values to the template by clicking on the Insert Variable button.

  • For the template format is CSV
    • Choose the character separating the fields when exporting the file in the Field Separate field
    • Select the character surrounding the fields when exporting the file in the Field Around field
    • To get the header field when exporting the file, choose "Yes" in the Include Field Header field
    • Allow adding any value you want into the Fields Map field. Please note that: The added values must be standard of Google or Facebook or Ebay, Amazon.

Step 3: Enter full information of Google Analytics​

These values will be added into URL of the product to know what the search engine is, what analytic keyword is, etc.

  • Enter the value for the Campaign Source field
  • Enter the value for the Campaign Medium field
  • Enter the value for the Campaign Name field
  • Enter the value for the Campaign Term field
  • Enter the value for the Campaign Content field

Step 4: Product Filter​

Choose the condition to export the file. All products meeting the conditions will be exported.

  • Here you can select the conditions for the feed. Only apply the rules for products meeting the conditions.

  • Maximum Product Displayed on Preview Product: Enter the maximum number of products shown in the Preview Product. If left empty, the number of displayed products when clicking the Preview Products button will not be limited.

Step 5: Enter the Category Map for products​

Admins can choose and classific according to the availabe suggestions. For the categories with the same level, it will get the classification type of the top-level category.

Step 6: Setup the method to send the exported file​
  • Delivery Config: Setup the method to send the exported file to the server
    • To send the exported file to the server, choose "Yes" in the Delivery field
    • Choose the method to send the file in the Protocol field: SFTP, FTP, HTTP Server, API, GraphQL.
      • SFTP: Authenticate with a password or a private key.
      • FTP: You can add the selection to use Passive Mode or not. We recommend that you should this mode to avoid being blocked by firewalls/NATs/proxies from sending files to the server.
      • HTTP Server: Send to the HTTP server by sending POST request, with custom headers. For example: https://httpbin.org/post
      • API / GraphQL: Send the feed file to API, GraphQL by sending POST, GET,... requests. For example: http://mageplaza/rest/V1/mpProductfeed/feed/file/, http://mageplaza/graphql,...
    • Enter the host name in the Host Name field. You can add the port at the end of the host name. For example: ftp.domain.com:22
    • Enter the user name in the User Name field
    • Enter the password to access the host in the Password field. Leave ** to keep the saved password. When a private key is used, this is the key passphrase (optional).
    • Private Key File: Show this field when selecting Protocol as SFTP. Click [...] and choose key file to connect with the server. You can skip choosing key file when your server can connect with a password.
    • If you want to save the file, only enter the path in the Directory Path field. Note: You need to set the name the export file at the end of the path
    • Request URL: Show this field when selecting Protocol as HTTP Server, API, GraphQL. Enter URL to send POST, GET,... request to HTTP Server, API; GraphQL.
    • Headers: Show this field when selecting Protocol as HTTP Server, API, GraphQL. Enter content to send POST, GET,... request. For example: Content-Type: application/json
    • Passwords and private keys are stored encrypted.
    • To check whether it is connected to the host, press Test Connection

Step 7: Check the update history of the exported file​

Admins can check the update history of the file in the Logs field.

Step 8: Synchronize product value with Google Shopping API​

Choose the information of the fields in Magento appropriately to send data to Google Shopping API. This tab will appear when Template File Type = XML.

  • Google Shopping API Field: Display the fields which are managed by Google Shopping API for this module based on the selected Magento fields.
  • Magento Fields:
    -> Fill in the Magento fields to get the data corresponding to the fields of Google Shopping API. -> If you leave this column blank or no value is existing, the Default value will be arquired and push to Google Shopping API.
  • Default mapping: Color, Size and Age Group are mapped by default. If Age Group is left empty, adult is sent.

  • MSI: With Multi-Source Inventory, Availability and quantity follow the stock of the website assigned to the feed.

  • Internal Note: Enter the description in the Internal Note section. This is only for admin to notice the information of the synchronization and is invaluable to data processing.

  • Insert Variables: Select the Magento Fields corresponding to the fields of Google Shopping API.

  • You can sync manually or sync via cron data from attributes of Magento Field to Google Shopping API.

ChatGPT (OpenAI) Feed Beta​

Beta

The ChatGPT (OpenAI) feed is in Beta. The OpenAI product feed specification is still changing, so the template and the validation rules may be updated in the next versions.

The ChatGPT (OpenAI) template creates a product feed for ChatGPT shopping, following the OpenAI product feed specification. The file is a TSV file (tab-separated, with a header row) of 34 columns.

How to set up​
  • Go to Products > Catalog > Product Feed > Manage Feeds, click Add New Feed.
  • In the Template tab, choose ChatGPT (OpenAI) and click Load Template.
  • In the General tab, set Compress File = Gz. OpenAI only accepts tsv.gz files.
  • Make sure Stores > Configuration > General > Store Information > Store Name is filled in. It is used for the seller_name column.
  • OpenAI standard uploads target the US market. If the default country of the store is not US, or the prices are not in USD, a warning is shown in the Validation Report.
  • Some columns need information of your store. They are left as placeholders in the template, replace them with your values:
    • accepts_returns: true or false, for example with a condition on a product attribute.
    • return_deadline_in_days: number of days. Only use it when accepts_returns is true.
    • return_policy, seller_tos, seller_privacy_policy: URL of your return policy, terms of service and privacy policy pages.
    • is_eligible_checkout: true when the product can be bought through ChatGPT checkout. It requires return_policy, seller_tos and seller_privacy_policy.
  • Click Generate. The file is checked against the OpenAI rules, and the result is shown in the Validation Report field of the General tab. Click the link to download the details as a CSV file.
  • Send the feed to OpenAI. OpenAI receives product feeds by SFTP:
    • Get the SFTP host, user name and password or private key from OpenAI.
    • In the Delivery tab (Step 6), set Delivery = Yes, Protocol = SFTP, and enter the information from OpenAI. When Delivery is enabled, the file is sent after each generation.
    • OpenAI expects a full snapshot of your catalog at least once a day. In the General tab, set Execution Mode = Cron and Frequency = Daily.

Columns of the template​
ColumnDefault value
item_idSKU
titleProduct name, plain text, up to 150 characters
descriptionProduct description, plain text, up to 5000 characters
urlProduct URL
brandAttribute Manufacturer
seller_nameStore name
seller_urlStore URL
image_urlMain product image
additional_image_urlsOther product images
availabilityStock status of the product
pricePrice with currency, for example 79.99 USD
sale_priceSpecial price with currency
group_idSKU of the parent product
listing_has_variationstrue when the product has a parent product
variant_dictVariant attributes of the product
gtinGTIN
mpnMPN
conditionnew
product_categoryCategory path
colorAttribute Color
sizeAttribute Size
weightProduct weight, when it is greater than 0
item_weight_unitWeight unit of the store
review_countNumber of reviews. Child products of a configurable product use the reviews of the parent product
star_ratingAverage rating, from 0 to 5
is_eligible_searchtrue
target_countriesStore country
store_countryStore country
accepts_returnsPlaceholder, enter your value
return_deadline_in_daysPlaceholder, enter your value
return_policyPlaceholder, enter your value
is_eligible_checkoutPlaceholder, enter your value
seller_tosPlaceholder, enter your value
seller_privacy_policyPlaceholder, enter your value

You can change the value of any column in the Template tab, the same as other templates.

What is checked​
  • Required columns: item_id, title, description, url, brand, seller_name, image_url, availability, price.
  • Availability: one of in_stock, out_of_stock, pre_order, backorder, unknown.
  • Price and Sale price: a positive amount with the currency, for example 79.99 USD. The sale price must be lower than the price and in the same currency.
  • True/false columns (is_eligible_search, is_eligible_checkout, listing_has_variations, accepts_returns...): lowercase true or false.
  • Variants: group_id must differ from item_id. When listing_has_variations is true, group_id is required. variant_dict must be a JSON object, for example {"color":"Black"}.
  • GTIN: 8, 12, 13 or 14 digits with a valid check digit.
  • Reviews: star_rating from 0 to 5, and it requires a positive review_count.
  • Weight: a positive number, with item_weight_unit one of g, kg, oz, lb.
  • Brand: a placeholder brand is not allowed.

Logs​

This section will record the process of generating files including information such as status, type, notification, etc. When you click on any files, it will automatically open the file.

From the Admin Panel, go to Products > Catalog > Product Feed > Logs

After manual or auto sync Facebook, Feed Logs will be created with Sync or Sync via Cron types

Clear All Logs Button: Delete all feed logs

Email notification about the status of the file​

Click on the View Logs, it will redirect the email recipients to the Feed Logs page to view the logs details.

Permission​

From the Admin Panel, go to System > Permissions > User Roles > Role Resources and choose Catalog > Mageplaza Product Feeds. The resources are Manage Feeds, Reports and Logs. A role that only has the Logs permission can view the logs, but cannot save, generate or delete feeds.

How to Run Command to Generate Feed​​

To generate one or more feed quickly, you can run the following command line:

php bin/magento mp-productfeed:generate {id}

  • In which: {id} is the Feed ID. If you do not fill Feed ID, all the feed will be generated.
  • Example: Generate some feed that you want, running the command:

php bin/magento mp-productfeed:generate 1 3 4

Note:

  • After installing the extension, you need to download Liquid by running the command composer require liquid/liquid or need to install the library
  • When the extension is enabled, Manage Feed and Logs will be displayed
  • To reload data of Report, you need to run the command: php bin/magento mp-productfeed:report

FAQs​

How to bulk upload product data for Product Feed in Magento 2?

Steps to bulk upload product data for Product Feed in Magento 2 by Mageplaza:

Step 1: Choose the method to send the file in the Protocol field: FTP or SFTP, HTTP Server, API, GraphQL.

Step 2:

  • For the FTP protocol, add the selection to use Passive Mode to avoid being blocked by firewalls/NATs/proxies.
  • HTTP Server: Send to the HTTP server by sending POST request. For example: https://httpbin.org/post.
  • API / GraphQL: Send the feed file to API, and GraphQL by sending POST, GET,… requests. For example: http://mageplaza/rest/V1/mpProductfeed/feed/file/, http://mageplaza/graphql,…

Step 3: Enter the hostname, user name, and the password.

Step 4: Choose the key file to connect with the server.

Step 5: Enter URL and content to send POST, GET,… request to HTTP Server, API; GraphQL.

How to get started with the Product Feed extension for Magento 2?
Firstly, you need to register an account for Google Shopping API and go to this link then create an OAuth client ID. After that, You can start the general configuration. From the Admin Panel, go to Store > Settings > Configuration > Mageplaza Extensions > Product Feed > Configuration. Then, you need to fill in the basic information according to the specific instructions right here.
What are the pros of using Magento 2 Product Feed extension?
    Here are some of the pros of using the Magento 2 Product Feed extension:
  1. Automated product feed generation
  2. Improved product visibility
  3. Enhanced SEO performance
  4. Advanced product feed customization
  5. Streamlined product feed management
  6. Integration with popular shopping platforms
  7. Premade templates leverage the option of generating product feed
What methods are available for uploading product feeds?
Product Feed for Magento 2 by Mageplaza supports multiple uploading methods, including FTP, SFTP, HTTP Server, API, and GraphQL. This flexibility ensures compatibility with various server configurations and workflows.
How can I add attributes for product filtering?
You can add attributes for product filtering by referring to this link.
What makes a good product feed?
A high-quality product feed should contain all the information about the product, including all the relevant attributes like the product type, brand, color, or size. It needs to be a comprehensive and well-structured file that provides accurate and detailed information about your products to online marketplaces. It also should adhere to the specific requirements of each platform, and be kept up-to-date to ensure optimal performance.
How can I choose the right template for displaying the product feed on an e-commerce channel?
You can check the feed templates that work for this shopping channel first. If this channel requires TXT, XML or CSV files, our extension absolutely suits.
What feed formats does Product Feed for Magento 2 support?
    Product Feed for Magento 2 supports five standard feed formats:
  1. XML (Extensible Markup Language)
  2. TXT (Plain Text)
  3. CSV (Comma Separated Values)
  4. XLS (Microsoft Excel Workbook)
  5. TSV (Tab-Separated Values)
Is Magento 2 Product Feed extension compatible with other extensions of Mageplaza?
Absolutely. This extension is compatible with Ajax Search, Required Login, Product Review extension, etc.

Maintenance​

Troubleshooting Articles​

For common issues and ways to fix, refer to these articles below:

Support And Assistance​

1. Customer Support​

For any assistance, please visit our Support Page or email us at cs@mageplaza.com/ sales@mageplaza.com

2. Create a Ticket​

If you need to create a support ticket, please open a ticket at this Link

3. Operating Hours​

Our support team is available during the following hours:

  • Monday to Friday: 8:00 AM - 23:59 PM
  • Saturday: 8:00 AM - 12:00 PM
  • Sunday: Closed

Refund Policy​

We understand that sometimes things don't go as planned. Please review our refund policy for detailed information:

Refund Policy Link

Frequently Asked Questions (FAQ)​

For quick answers to common questions, please visit our FAQ page:

FAQ Page Link

Must-have extensions for your Magento stores​​