Connect your PIM

Summary

Connect Your PIM

Digital Showroom connects to your Akeneo PIM using the Connect Apps framework. This secure OAuth-based connection allows Digital Showroom to read your product catalog, categories, attributes, and assets, and to receive real-time updates when your product data changes.

Prerequisites

Before activating Digital Showroom, make sure you have:

An Akeneo PIM instance (Growth or Enterprise edition) with admin access
The Digital Showroom application available in your PIM's Connect Apps marketplace

Note: Digital Showroom uses Akeneo Connect Apps for authentication, not the standard Akeneo REST API OAuth flow. Tokens are obtained through the Connect Apps authorization process and cannot be refreshed using client credentials alone.

Activate the Connection

The connection is initiated from your Akeneo PIM, not from Digital Showroom itself. Here is how to activate it:

Log in to your Akeneo PIM as an administrator.
Go to Connect > App Store in the PIM navigation menu.
Find Digital Showroom in the list of available apps and click on it.
Click Connect to start the activation process.
The PIM redirects you to the Digital Showroom authorization page, where you can review the permissions being requested.
Click Authorize to grant Digital Showroom access to your product data.
Once authorized, you are redirected back to Digital Showroom, and the connection is established.

What Permissions Are Granted

During activation, Digital Showroom requests the following OAuth scopes from your PIM:

read_products — Read product data (attributes, values, associations)
read_catalog_structure — Read families, attributes, and attribute groups
read_categories — Read the category tree structure
read_asset_families and read_assets — Read asset families and their media files
read_catalogs, write_catalogs, and delete_catalogs — Manage PIM catalog configurations used for product selection
read_channel_localization and read_channel_settings — Read channel, locale, and currency configuration
read_attribute_options — Read attribute option values (for select attributes)
read_association_types — Read product association types
read_reference_entities and read_reference_entity_records — Read reference entity data
manage_event_subscriptions — Manage subscriptions to the Akeneo Events Platform to receive real-time product update notifications

Note: Digital Showroom only reads your product data. It does not modify your products, attributes, or categories in the PIM. The write and delete scopes for catalogs are used solely to manage the catalog mapping configuration that determines which products are shared with Digital Showroom.

Automatic Data Synchronization

After the catalog is enabled and configured, Digital Showroom automatically synchronizes your product data:

An initial full synchronization imports all products from the configured catalog into Digital Showroom's search index.
Going forward, Digital Showroom subscribes to the Akeneo Events Platform to receive real-time notifications when products are created, updated, or deleted in your PIM.
Changes are processed automatically, so your Digital Showroom product data stays in sync with your PIM.

Note: Depending on the size of your product catalog, the initial synchronization can take from a few minutes to several hours. Don't worry if all the products are not immediately visible — they will appear progressively as the import completes.

View Your PIM Connection Settings

Once connected, you can review the current connection settings in Digital Showroom:

Log in to Digital Showroom as an administrator.
Go to Admin > PIM Settings in the navigation menu.
This page displays the channels, locales, and currencies that are configured on your PIM catalog, as well as the total number of products available.
Click PIM Catalog to navigate directly to the catalog configuration in your Akeneo PIM.

Troubleshooting

The connection fails or products are not syncing

Product data is synchronized automatically between your Akeneo PIM and Digital Showroom.

When you first activate Digital Showroom, a full synchronization imports all products from the configured catalog.
After the initial sync, changes in your PIM (product creation, update, or deletion) are received in real time through the Akeneo Events Platform.
Digital Showroom processes these events and updates its search index accordingly.

Note: Depending on the size of your catalog, the initial synchronization can take some time. Large catalogs with tens of thousands of products may require several hours to fully index. Don't worry — products will appear progressively as the import completes, and you can already start configuring your portfolios in the meantime.

Tip: If you notice that some recently updated products are not yet reflected in Digital Showroom, give it a few minutes. Real-time synchronization events are processed as they arrive, but there may be a short delay during peak activity.

If your connection stops working or products are not updating:

Go back to your Akeneo PIM and navigate to Connect > Connected Apps.
Find Digital Showroom in the list and check that it shows as Connected.
If the connection appears broken, you may need to re-activate it by going through the Connect Apps authorization flow again (repeat the steps in "Activate the Connection" above).

Important: You cannot manually refresh the access token. If the token becomes invalid, the only way to restore the connection is to re-activate Digital Showroom through the OAuth flow in your PIM.

I don't see all products on Digital Showroom

Check your settings: Digital Showroom uses the Akeneo PIM Catalogs feature to define which products are shared. the PIM catalog controls the overall product scope available to Digital Showroom. The portfolio-level filters you configure within Digital Showroom further refine this scope per portfolio.

To see the total number of available products, go to Portfolio > PIM Settings page. To update your PIM settings, click PIM Catalog to go directly to the catalog configuration in your PIM.

Akeneo Help Center