For arlanix/product-feed 1.0
Arlanix Product Feed documentation
For the developer who installs and looks after the module. Feeds themselves are made in the admin by the store; the manual is written for them, and links here where a developer is needed.
Requirements
- Magento Open Source or Adobe Commerce 2.4.7 or later.
- PHP 8.1 or later, with
zip,curl,xmlwriterandmbstring. - A working Magento cron. Feeds are built and delivered by it; without it nothing runs on its own.
Packages
arlanix/product-feed is a metapackage, sold on Adobe Commerce Marketplace. It installs every module below at matching versions.
| Package | Module | Purpose |
|---|---|---|
arlanix/module-core |
Arlanix_Core |
Shared by every Arlanix module: logging and the support bundle. |
arlanix/module-feed |
Arlanix_Feed |
Feeds, field mapping, dictionaries, Google categories, the built feed data and the delivery channels. |
arlanix/module-feed-types |
Arlanix_FeedTypes |
The field catalogs of Google Shopping, Meta, TikTok, Pinterest, Snapchat and Microsoft, and the dictionaries they map to. A correction to a platform's specification is a release of this module alone. |
arlanix/module-feed-google-merchant |
Arlanix_FeedGoogleMerchant |
Merchant Center accounts and data sources, and the Merchant API channel. |
arlanix/module-feed-sftp |
Arlanix_FeedSftp |
SFTP delivery, by password or private key. |
arlanix/module-feed-inventory |
Arlanix_FeedInventory |
Multi Source Inventory: a feed picks the sources its stock is counted from. Stands aside on a store with MSI switched off. |
How a feed runs
- Build. The catalogue of every store view a feed uses is read into the module's own tables. Indexers follow product, category and stock changes, so after the first full build only changed products are read again.
- Generate. A feed that is due, by its schedule or by Generate now, maps the built products through its fields, dictionaries and modifiers into rows. A product with nothing in a field the mapping marks Required, or one a dictionary excludes, is left out and counted in Run History. What the feed type's catalog finds beyond that, a value it does not list, a text over its length, a required field with no rule, is a warning there, and the row goes anyway.
- Deliver. The rows are written as a file and published under
pub/media/arlanix/feeds/, uploaded by SFTP, or registered with Merchant Center; or, for the Merchant API channel, compared with what was sent last and pushed product by product.
Each step is a cron job; Cron and command line lists them, and how to run the same steps by hand.
Pages
- Install: Composer, the upgrade, Multi Source Inventory, and the check to hand back to the store.
- Cron and command line: the jobs, checking them,
arlanix:feed:generate, files and log. - SFTP delivery: connections, host-key fingerprints, Merchant Center's SFTP server.
- Google Merchant Center: the service account and the Merchant API channel.
- The support bundle is downloaded from the admin, without SSH.