The Magento Tweakwise Export extension is the bridge between your Magento shop and the Tweakwise platform. This extension generates a structured XML feed containing your products, categories, and attributes, allowing Tweakwise to power your site's search, merchandising, and filtering with up-to-date data.
Follow these steps to configure the extension correctly.
For more details, check the extended documentation.
1. Install the Export extension
Install the Magento2TweakwiseExport plugin that will make it possible to get your data in Tweakwise.
Follow the readme to learn more.
2. Determine your attributes
Before starting the export, you must decide which data Tweakwise needs for searching, sorting, and filtering.
- Go to Products > Attributes > Storefront Properties.
- Tweakwise will include an attribute in the export if any of these settings are set to Yes:
- Use in search
- Layered navigation (any setting except 'No')
- Use in search layered
- Use in product listing / sorting / advanced search.
3. Link your Tweakwise instance
To authorize the connection, you need your unique instance key.
- Navigate to Stores > Configuration > Catalog > Tweakwise.
- In the General section, enter your instance key in the Instance key field (some versions refer to this field as "Authentication key").
4. Finetune Export settings
In the Export section, you define how and when the feed is generated:
- Enabled: Set to 'Yes' to activate feed generation.
- Key: Enter a unique string (e.g., your instance key). This forms your feed URL:
/tweakwise/feed/export/key/[YOUR_KEY]. - Allow cache flush: Set to 'Yes'. This allows Tweakwise to clear your shop's cache automatically after publishing new data.
- Tweakwise Import API Url: Paste the URL found in the Tweakwise App (Import Task details). This triggers Tweakwise to start importing as soon as the Magento export finishes.
- Schedule full export: Enter a Cron notation. Best Practice: Match this frequency to your Tweakwise contract.
5. Optional: Frequent Stock & Price updates
If your prices or stock levels change rapidly, you can set up separate, faster exports.
- Configure the Export Stock/Price settings with a more frequent Cron schedule.
- These use specific URLs:
/tweakwise/feed/export/key/[KEY]/type/stock(orprice).
In the same way additional export tasks can be created to handle complex scenarios like customer-specific catalogs. You can configure these additional tasks to run on their own schedules.
Important considerations
- Store Level Export: Only enable this if you need separate Tweakwise instances per store view. Be aware that separate instances often result in additional license costs.
- Batch Sizes: If you encounter "Out of Memory" errors during export, lower the Batch size for categories and products. If the export is too slow, you can increase these values.
Frequently asked questions
Why are my new product attributes not appearing in the Tweakwise feed? Check the "Storefront Properties" of the attribute in Magento. It must be set to "Used in Search" or "Used in Layered Navigation" (among others) for the extension to pick it up. After changing this, you must run a new export.
What happens if the export validation fails? If you have "Validate" enabled, the extension checks the product and category counts. If the numbers look suspicious (e.g., zero products), the export will be blocked to prevent Tweakwise from importing an empty catalog and clearing your storefront.
How do I make sure Tweakwise shows the latest data immediately? Ensure "Allow cache flush" is enabled and you have provided the flush URL to your Tweakwise contact. Also, make sure the "Tweakwise Import API Url" is configured so the import starts automatically after the export finishes.
