Build catalog

To power Tweakwise’s Smart Search and Merchandising, you need to synchronize your product catalog with our platform. This milestone focuses on establishing a robust data pipeline from your source system to Tweakwise.

This document answers:

• Which integration method should I choose?
• How do I structure my data for optimal performance?
• What are the technical requirements for each method?

Data Ingestion Options

Tweakwise provides four primary ways to ingest data. While the XML Feed is the standard recommendation for most implementations, specific architectures (like Headless or PWA) may benefit from the Backend API.

1. E-commerce Platform Plugins

If you use a supported platform, the easiest route is our native plugins. They handle the data export automatically.

• Supported: Magento 2, Shopify, Shopware 6, Sana Commerce, Vendre.
• How it works: Install the extension, configure the attributes you want to export, and the plugin generates the required feed.

2. XML Feed (Recommended)

The most common and flexible method. You host an XML file that Tweakwise fetches at scheduled intervals.

• Best for: Large catalogs, multi-store setups, and stable data structures.
• Implementation:
  1. Generate a valid XML structure containing <items> and <categories>.
  2. Map your attributes (e.g., price, stock, color) to Tweakwise attributes.
  3. Host the file on a secure URL (Basic Auth or IP-whitelisting supported).
  4. Create an Import Task in the Tweakwise App.

XML Feed guide →

3. Backend API (REST)

For real-time updates or headless environments where a static feed isn't feasible.

• Best for: Real-time stock/price updates or custom-built e-commerce engines.
• Endpoint: POST /api/v1/items
• Key Advantage: Incremental updates. You only push what changed, rather than re-importing the entire catalog.

Backend API guide →

4. Channable Integration

If you already use Channable for feed management, you can use the Tweakwise channel to push data.

• Note: While convenient, Channable has limitations regarding complex category hierarchies and multi-language support in a single feed.
• Setup: Add the Tweakwise channel in Channable and map your fields to our standard schema.

Channable guide →

Next Steps

Once your data is flowing, proceed to Milestone 4: Configuration & Implementation to start building your frontend.