WordPress PluginSettings Reference

ProductSync Settings Reference

All settings are found at ProductSync menu in your WordPress admin.


Connection

Public Token

Your unique token that connects this WordPress site to your ProductSync dealer account.

  • Where to find it: Log into productsync.io, open any catalog → Embed Code tab → copy the Public Token value
  • Format: A long string of letters and numbers (same token used by the widget embed)
  • Security: The token is stored securely in your WordPress database and never exposed in your website’s public HTML
  • Test Connection: Click the “Test Connection” button to verify the token is valid and productsync.io is reachable

Catalog ID

The identifier for the specific catalog group to display on this site.

  • Where to find it: Same location as the Public Token — on the Embed Code tab, below the token
  • Format: Starts with cl followed by letters and numbers (e.g., clxxxxxxxxxxxxxxxxx)
  • Multiple catalogs: If you have multiple catalog groups, each has its own Catalog ID. The one you set here becomes the default. You can override it per-block or per-shortcode.

Catalog Display

Catalog Path

The URL path where your product catalog will be displayed.

  • Default: fireplaces
  • Result: Your catalog appears at yoursite.com/fireplaces/
  • Rules:
    • Must be a single word (letters, numbers, and hyphens only)
    • Cannot conflict with an existing WordPress page or post
    • Cannot conflict with WooCommerce slugs (shop, product base, category base, cart, checkout)
    • Common choices: fireplaces, products, catalog, shop
  • After changing: The plugin automatically updates its URL routes. If your catalog shows a 404 after changing this, go to Settings → Permalinks and click Save Changes.

Caching

Product Page Cache (seconds)

How long individual product pages are cached before fetching fresh data from ProductSync.

  • Default: 300 seconds (5 minutes)
  • Recommended range: 60–600 seconds
  • Set to 0: Disables caching (every visit fetches from the API — not recommended for production)

Category Page Cache (seconds)

How long category/listing pages are cached. These are cached longer because they change less frequently.

  • Default: 3600 seconds (1 hour)
  • Recommended range: 600–7200 seconds

Clear Cache Button

On the Status tab, the “Clear All Cache” button immediately removes all cached catalog pages. Use this when:

  • You’ve just updated products in ProductSync and want changes visible immediately
  • You’re troubleshooting display issues
  • You’ve changed your catalog path

Advanced

Webhook Secret

An auto-generated secret key used to verify cache invalidation requests from ProductSync.

  • Auto-generated: Created when the plugin is first activated
  • Usage: Paste this into your ProductSync dealer portal on the Embed Code tab, under the WordPress Plugin section → Webhook Secret field
  • Purpose: When you update a product in ProductSync, the system sends a request to your WordPress site to clear that specific product’s cache. The secret ensures only legitimate requests are accepted.
  • Do not share: This is a security credential. Only paste it into your ProductSync dealer portal.

Status Tab

The Status tab provides a quick overview:

IndicatorMeaning
🟢 ConnectedPublic token is valid, productsync.io is reachable
🔴 ErrorConnection failed — check token or hosting firewall
🟡 CheckingConnection test in progress
No tokenNo public token has been configured yet

WooCommerce Card

If WooCommerce is active, the Status tab shows:

  • WooCommerce version
  • Shop page slug, product base, and category base
  • Any URL conflicts with your catalog path

Embedding Card

Shows all three active display methods:

  • Full-page route path
  • Gutenberg block name (productsync/catalog)
  • Shortcode ([productsync])

Gutenberg Block Settings

When you add the ProductSync Catalog block to a page, the block inspector (right sidebar) offers:

SettingDescriptionDefault
Catalog IDOverride the global catalog ID for this block(uses global setting)
Show FiltersShow or hide the filter sidebarOn
Maximum ProductsLimit the number of products displayed50

Shortcode Attributes

The [productsync] shortcode accepts these attributes:

AttributeDescriptionDefault
catalog_idOverride the global catalog ID(uses global setting)
show_filters"true" or "false""true"
max_productsMaximum number of products"50"
pathRender a specific catalog path (e.g., /category/gas-fireplaces)"/"

Layout Template Page

ProductSync menu → Catalog Display → Layout Template Page

By default, ProductSync builds catalog pages with an automatic layout matched to your theme. If you want full design control — a hero banner, custom headings, sidebars, anything your page builder can do — use a layout template page instead:

  1. Create a normal WordPress page in your theme’s builder (Divi, Kadence, Elementor, Gutenberg, …). Design it however you like.
  2. Put the [productsync_content] shortcode where the catalog content should appear.
  3. Publish the page, then select it under Layout Template Page and save.

Every catalog URL (shop pages, categories, filtered listings, product pages) now renders through that page: your design wraps the catalog, on any theme, with no custom code. SEO stays correct automatically — the catalog URL keeps its own title, meta description, canonical URL, and structured data; the template page’s own SEO tags are suppressed on catalog routes.

Notes:

  • The template page itself (viewed directly at its own URL) shows your design with an editors-only placeholder note where the shortcode sits. Visitors see nothing there — consider leaving it out of your menus.
  • If your theme shows the page title automatically, hide it in the page settings (most builders have a “hide page title” toggle) — the catalog provides its own headings.
  • Set the dropdown back to None at any time to return to the automatic layout.

Composing with part shortcodes

Instead of the all-in-one [productsync_content], the template page can place each catalog section individually — full layout control in your builder:

ShortcodeSection
[productsync_heading]Listing H1
[productsync_search]Search form (name / model number / SKU)
[productsync_filters layout="horizontal"]Filter UI — horizontal accordion bar or sidebar widget list
[productsync_toolbar]Result count + sort dropdown
[productsync_grid]The product grid
[productsync_pagination]Page links
[productsync_product_breadcrumbs], [productsync_product_title], [productsync_product_price], [productsync_product_gallery], [productsync_product_short_description], [productsync_product_options], [productsync_product_cta], [productsync_product_form], [productsync_product_meta], [productsync_product_description], [productsync_product_specs], [productsync_product_files], [productsync_product_videos], [productsync_product_related]Product page sections (for Divi Theme Builder-style product templates)

Listing parts render only on listing/category/shop routes; product parts render only on product routes. One template page can safely contain both stacks — whichever doesn’t apply outputs nothing.

Standalone embeds on any page

  • [productsync_grid category="grills" brand="napoleon-grills" attribute="fuel-type:wood,venting-type:direct-vent" limit="12" sort="price-asc"] — a filtered product grid anywhere (landing pages, brand pages). Not paginated; use limit to size it. attribute takes comma-separated attribute-slug:value-slug pairs from your filter vocabulary.
  • [productsync_search] / [productsync_filters] — work on regular pages too; they target your first takeover listing route, or set target="shop" explicitly.