Skip to main content

PIM Integration

Connect your Plytix account to sync product data​

Where to find it: Admin → Catalog → Product Information Management → PIM Integration

When you'd use this: You manage rich product content in Plytix (descriptions, images, specifications) and want to bring that data into CommerceBuild to supplement or replace basic product information from your ERP.

What you need first:

  • A Plytix account with product data
  • Your Plytix API Key and API Password (found in Plytix under Settings → API)
  • PRODUCT_WRITE permission in the ADMIN_CATALOG privilege group

Set it up:

  1. Navigate to Admin → Catalog → Product Information Management → PIM Integration
  2. Click Add PIM Connection (or select Plytix from the provider list if no connection exists yet)
  3. Enter a label for this connection (e.g. "Plytix Production")
  4. Enter your Plytix API Key and API Password
  5. Choose whether this is a sandbox or production connection
  6. Click Save

CommerceBuild validates your credentials when you save. If the connection fails, double-check your API Key and API Password in your Plytix account settings.

Using it day-to-day:

Once connected, you can configure which product attributes to sync and trigger product imports from Plytix. The connection credentials are stored securely and used automatically for all sync operations.

To update your connection settings:

  1. Return to Admin → Catalog → Product Information Management → PIM Integration
  2. Select your existing Plytix connection
  3. Update the label, credentials, or sandbox/production mode as needed
  4. Click Save

CommerceBuild re-validates the connection each time you update credentials.

Troubleshooting:

  • Invalid PIM credentials error when saving — Your API Key or API Password is incorrect. Copy the credentials directly from Plytix Settings → API and ensure there are no extra spaces.

  • Unable to connect to the PIM provider — Plytix may be temporarily unavailable, or your network may be blocking the connection. Wait a few minutes and try again.

  • Connection saves without credentials — You can save a connection without entering credentials (for example, to reserve the integration slot), but you'll need to add valid credentials before you can sync product data.

Sync product attributes from your PIM to custom fields​

Where to find it: Admin → Catalog → PIM Integration → Attribute Configuration

When you'd use this: You store rich product data in Plytix (e.g. material, dimensions, certifications) and want to display that information on product pages without manual data entry.

What you need first:

  • An active Plytix integration configured in Admin → Catalog → PIM Integration
  • PRODUCT_WRITE permission in the ADMIN_CATALOG privilege group

Set it up:

  1. Navigate to Admin → Catalog → PIM Integration → Attribute Configuration
  2. Click Reload Attributes to fetch the latest attribute definitions from your Plytix environment
  3. Review the list of available attributes — each shows:
    • The attribute name and label from Plytix
    • The attribute type (e.g. TextAttribute, BooleanAttribute)
    • How it will be stored in CommerceBuild (e.g. Text Box, Check Box)
  4. Select the checkbox next to each attribute you want to sync to your webstore
  5. Click Save Selection

CommerceBuild will create a product custom field for each selected attribute. These fields are marked as PIM-managed and cannot be edited manually — their values come directly from Plytix.

Using it day-to-day:

Once configured, attribute values sync automatically whenever products are synced from Plytix:

  1. Product sync runs (either scheduled or manually triggered)
  2. CommerceBuild fetches the selected attribute values for each product
  3. Values are stored in the corresponding custom fields
  4. Custom fields appear on product detail pages according to your theme template

When you add a new attribute or remove an existing one:

  1. Return to Admin → Catalog → PIM Integration → Attribute Configuration
  2. Select or deselect attributes as needed
  3. Click Save Selection

CommerceBuild automatically updates the product catalog index when you change your attribute selection:

  • Adding attributes: The new attribute's values will sync from Plytix and appear in the product API once the sync completes.
  • Removing attributes: The custom field and all stored values are deleted immediately across all products, and the product API stops returning the removed attribute without any manual reindex.

Troubleshooting:

  • Reload Attributes button returns an error — Your Plytix integration may be disconnected or have expired credentials. Check Admin → Catalog → PIM Integration and verify the connection is active.

  • Custom field values are empty after sync — The attribute may not have values set in Plytix for those products, or the product sync may still be running. Check the sync status in Admin → Integrations → Sync History.

  • I don't see an attribute I need — Some attribute types are not synced: Completeness (internal Plytix scores), Media, and Media Gallery attributes. These are not supported as custom fields.

  • Attribute values appear as text instead of formatted data — CommerceBuild stores decimal numbers, dropdowns, and multi-select values as text. You may need to format these in your storefront theme template.