Magento 2
CatalogRelay exports products to Magento 2 via the Magento REST API.
Prerequisites
Section titled “Prerequisites”- Magento 2.4 or later
- An integration user with appropriate API permissions
- Your store’s base URL
Creating a Magento API integration
Section titled “Creating a Magento API integration”- In Magento Admin, go to System → Integrations → Add New Integration
- Give it a name (e.g. “CatalogRelay”)
- Under API, set permissions:
- Catalog → Products (read, write)
- Catalog → Categories (read)
- Store → All Store Views (read)
- Click Save and then Activate
- Copy the Access Token
Connecting in CatalogRelay
Section titled “Connecting in CatalogRelay”- Go to Export Destinations → Add destination
- Select Magento 2
- Enter:
- Store URL: your Magento base URL (e.g.
https://store.example.com) - Access Token: from the integration you created
- Store View: which store view to sync to (default:
all/default) - Root Category ID: the root category to assign products to (usually
2)
- Store URL: your Magento base URL (e.g.
What gets synced
Section titled “What gets synced”Standard fields
Section titled “Standard fields”| CatalogRelay | Magento field |
|---|---|
| Name | name |
| SKU | sku |
| Description | description |
| Short description | short_description |
| Price (after rules) | price |
| Stock | extension_attributes.stock_item.qty |
| GTIN | custom_attributes.ean |
| Status | based on availability |
| Visibility | Catalog, Search |
Custom attributes
Section titled “Custom attributes”Map canonical attributes to Magento EAV attribute codes via Field Mappings in the export profile. The Magento attribute must already exist with the matching code.
Example mapping:
- Canonical:
delivery_days→ Magento:custom_attributes.delivery_time
Categories
Section titled “Categories”Use a category set configured with Magento category IDs (integer) as destination codes. CatalogRelay assigns products to categories by ID.
Stock management
Section titled “Stock management”By default, CatalogRelay sets is_in_stock based on the stock quantity:
- Stock > 0 → in stock
- Stock = 0 → out of stock,
qty = 0
If you use MSI (Multi-Source Inventory), contact support for MSI-aware sync options.
Store views and websites
Section titled “Store views and websites”CatalogRelay can sync to a specific store view. To sync the same products to multiple store views (e.g. different locales), create multiple export profiles, one per store view.
Indexing
Section titled “Indexing”After importing products, Magento’s indexers may need to run. CatalogRelay triggers reindexing via the API for the affected indexers (price, stock, search). If you notice search results not updating, ensure the catalogsearch_fulltext indexer is running.
Troubleshooting
Section titled “Troubleshooting”401 Unauthorized: The access token is invalid or the integration was revoked. Re-activate the integration in Magento and update the token in CatalogRelay.
Product not appearing in search: Ensure the product is set to Visibility: Catalog, Search and that the search indexer has run.
Category not assigned: Verify the category ID in your category set matches an existing Magento category. Root category (ID 1) cannot hold products — use a subcategory.