Skip to content

WooCommerce

CatalogRelay exports products to WooCommerce via the WooCommerce REST API (v3).

  • WordPress with WooCommerce 6.0 or later
  • REST API enabled (Settings → Advanced → REST API)
  1. In WordPress Admin, go to WooCommerceSettingsAdvancedREST API
  2. Click Add key
  3. Enter a description (e.g. “CatalogRelay”) and set Permissions to Read/Write
  4. Click Generate API key
  5. Copy the Consumer Key and Consumer Secret
  1. Go to Export DestinationsAdd destination
  2. Select WooCommerce
  3. Enter:
    • Store URL: your WordPress URL (e.g. https://shop.example.com)
    • Consumer Key: ck_...
    • Consumer Secret: cs_...

CatalogRelay tests the connection and verifies API access before saving.

CatalogRelayWooCommerce field
Namename
Descriptiondescription
SKUsku
GTINmeta_data._barcode or ean (depending on plugin)
Price (after rules)regular_price
Stockstock_quantity
Availabilitystock_status (instock / outofstock / onbackorder)
Image URLimages[].src

Map canonical attributes to WooCommerce product attributes or meta data:

canonical: delivery_days → attributes.Delivery Days
canonical: material → meta_data.material

For filterable attributes, ensure the attribute exists in WooCommerce (ProductsAttributes) before mapping.

Use a category set with WooCommerce category slugs or IDs as destination codes. CatalogRelay assigns products to categories by slug or ID.

CatalogRelay sets:

  • manage_stock: true
  • stock_quantity to the current stock value
  • stock_status based on stock and availability:
    • stock > 0 AND availability = in_stock → instock
    • stock = 0 → outofstock
    • availability = preorder → onbackorder

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.

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.