Getting Started with Product Sync
Product Sync synchronizes products, collections, facet values, and related metadata from your Vendure backend into WordPress.
With this plugin you can:
- Sync products from Vendure into WordPress
- Sync taxonomy data from collections and facet values
- Keep storefront content updated for Elementor widgets and dynamic tags
Prerequisites
- Haus Storefront plugin installed and activated
- A running Vendure ecommerce backend
- Access to your WordPress admin
- WP-CLI access (for running sync)
Quick Setup
- Install and activate Product Sync.
- Go to Sync Settings in the Haus Storefront menu.
- Add taxonomy mappings (optional):
- Type:
collectionorfacet - WP taxonomy: the taxonomy slug in WordPress (for example
product-brands) - Source data:
- Collection root ID (for
collection) - Facet code (for
facet)
- Collection root ID (for
- Type:
- Click Save.
Your sync configuration is now ready.
Sync data
Run the full sync from terminal with WP-CLI:
wp sync-products sync
Data Handling
Product Sync stores synchronized data directly in WordPress.
Core WordPress tables used
- Products:
wp_posts - Product metadata:
wp_postmeta - Taxonomy terms:
wp_terms+wp_term_taxonomy - Term metadata:
wp_termmeta - Product-to-taxonomy relationships:
wp_term_relationships
Product metadata keys
vendure_id- Unique Vendure product ID used for matching updates.vendure_updated_at- Last time this product record was updated in WordPress during sync.vendure_description- Synced product description value.vendure_featured_asset_source- URL/path to the featured product image.vendure_num_option_groups- Number of option groups for the product.vendure_slug_mismatch- Flag set when the WordPress slug differs from expected backend slug.vendure_*- Synced Vendure custom field values stored with a prefixed key.exclude_from_sync- Optional flag to skip this product in sync runs (if enabled in your setup).
Term metadata keys (wp_termmeta)
vendure_collection_id- Vendure collection ID for collection taxonomies.vendure_term_id- Vendure facet value ID for facet taxonomies.vendure_updated_at- Last time this term record was updated in WordPress during sync.vendure_soft_deleted- Indicates the term is marked as deleted/inactivated in sync state.vendure_term_image- Synced image reference for the term.vendure_term_position- Position/order value from Vendure data.vendure_slug_mismatch- Flag set when the WordPress term slug differs from expected backend slug.vendure_*- Synced Vendure custom field values stored with a prefixed key.
Synced Data
This plugin does not include a built-in UI for viewing or managing fields. To work with synced fields in the WordPress admin, you need a field UI plugin.