WooCommerce
CatalogRelay exports products to WooCommerce via the WooCommerce REST API (v3).
Prerequisites
Section titled “Prerequisites”- WordPress with WooCommerce 6.0 or later
- REST API enabled (Settings → Advanced → REST API)
Creating WooCommerce API credentials
Section titled “Creating WooCommerce API credentials”- In WordPress Admin, go to WooCommerce → Settings → Advanced → REST API
- Click Add key
- Enter a description (e.g. “CatalogRelay”) and set Permissions to Read/Write
- Click Generate API key
- Copy the Consumer Key and Consumer Secret
Connecting in CatalogRelay
Section titled “Connecting in CatalogRelay”- Go to Export Destinations → Add destination
- Select WooCommerce
- Enter:
- Store URL: your WordPress URL (e.g.
https://shop.example.com) - Consumer Key:
ck_... - Consumer Secret:
cs_...
- Store URL: your WordPress URL (e.g.
CatalogRelay tests the connection and verifies API access before saving.
What gets synced
Section titled “What gets synced”Products
Section titled “Products”| CatalogRelay | WooCommerce field |
|---|---|
| Name | name |
| Description | description |
| SKU | sku |
| GTIN | meta_data._barcode or ean (depending on plugin) |
| Price (after rules) | regular_price |
| Stock | stock_quantity |
| Availability | stock_status (instock / outofstock / onbackorder) |
| Image URL | images[].src |
Custom attributes
Section titled “Custom attributes”Map canonical attributes to WooCommerce product attributes or meta data:
canonical: delivery_days → attributes.Delivery Dayscanonical: material → meta_data.materialFor filterable attributes, ensure the attribute exists in WooCommerce (Products → Attributes) before mapping.
Categories
Section titled “Categories”Use a category set with WooCommerce category slugs or IDs as destination codes. CatalogRelay assigns products to categories by slug or ID.
Stock management
Section titled “Stock management”CatalogRelay sets:
manage_stock: truestock_quantityto the current stock valuestock_statusbased on stock and availability:- stock > 0 AND availability = in_stock →
instock - stock = 0 →
outofstock - availability = preorder →
onbackorder
- stock > 0 AND availability = in_stock →
Image handling
Section titled “Image handling”CatalogRelay sends image URLs to WooCommerce. WooCommerce downloads and stores the images locally. Ensure your supplier’s image URLs are publicly accessible.
Note: WooCommerce image importing can be slow for large catalogues. Initial sync may take considerable time if many products have new images.
Troubleshooting
Section titled “Troubleshooting”403 Forbidden: The consumer key/secret doesn’t have write permissions, or the WooCommerce REST API is not enabled. Regenerate the key with Read/Write permissions.
Products creating duplicates: WooCommerce matches products by SKU. If CatalogRelay sends a SKU that exists in WooCommerce, it updates rather than creates. If you see duplicates, ensure SKUs are consistent between CatalogRelay and WooCommerce.
Attributes not appearing as filterable: WooCommerce requires attributes to be set as is_visible and is_variation appropriately. Set these in the WooCommerce attribute settings for attributes you want customers to filter by.