Integrations overview
Ways to get your catalog in
Search needs your products in an index. You can fill it in four ways:
| Way | Best for | Set it up in | Guide |
|---|---|---|---|
| Magento 2 module | Magento 2.4.6 and later. One index per store view, prices and stock included, updated within about a minute. | The Magento admin, with a key from the cabinet | Magento 2 |
| Product feed | Any shop that can publish a full catalog as CSV, JSON, JSON Lines or XML, Google Shopping feeds included. | The cabinet, on the index's Data source page | Product feed |
| File upload | A first test, or a catalog that rarely changes. | The cabinet, on the index's Documents page | Quickstart |
| REST API and MCP | Your own code, or an AI agent, sends the documents. | Your code, with a key from the cabinet | REST API and MCP |
Pick one
Use the platform module when there is one. It sees every product, price and stock change as it happens, so search is never more than a minute behind the shop.
Use a product feed when your platform has no module yet but can export its catalog to a URL. Zaproo downloads it on a schedule, so search is as fresh as the schedule allows: once a day on the Free plan, every 15 minutes on Enterprise. You set it up in the cabinet, with no code.
Use the REST API when you build the shop yourself, or when the data comes from several systems. You decide when and what to send.
Each index takes its documents from one of these. A platform module and a data source can't feed the same index at once.
Coming soon
Modules for these platforms are in progress. Until yours is ready, connect the shop through a product feed or the REST API.
Integrations in the cabinet
A platform module tells Zaproo which index it keeps in sync. From then on, the index's Overview and its Data source page show an Integration panel with:
- Connected: the shop's name, for example the Magento store view, with a link to the shop when the module sends one.
- Platform: for example Magento 2, with the module's version.
- Manages the mapping: Yes while the module adds fields for new shop attributes.
- Connected since: when the module first linked the index.
While a shop is linked:
- The index's data source is off, and the Data source page says so. A data source saved earlier stays stored and resumes once the shop is disconnected.
- The module can add fields to the mapping for new shop attributes. Once a field is saved, you own it: change its type, flags or text analysis in Fields & mapping. You can't remove a field while the module manages the mapping. See Mapping and fields.
- You follow the module's writes on the index's Tasks page. See Documents and tasks.
Disconnect a shop
Disconnect a shop after it is closed or the module is uninstalled. Only organization owners and admins can do it.
- Open the index's Overview or Data source page.
- In the Integration panel, click Disconnect shop name.
- Click Disconnect to confirm.
The documents stay in the index. A module that is still installed links the index again the next time its settings are saved. With the API, send DELETE .../integration; see the REST API reference.