Install Smart PIM

Last updated: April 27, 2026

Edit on GitHub

Smart PIM is an AI tool embedded in the Back Office product creation and editing pages. It provides AI-powered capabilities for improving product content, generating image alt text, suggesting categories, and translating product data. This document describes how to install the Smart PIM feature.

Install the feature core

Follow the steps in the following sections to install the Smart PIM feature core.

Prerequisites

Install the required features:

NAME	VERSION	INSTALLATION GUIDE
AI Commerce	202602.0	Install AI Commerce
Product Management	202602.0

Make sure the following modules are installed at the required minimum versions:

MODULE	MINIMUM VERSION
`spryker/ai-commerce`	`^0.4.2`
`spryker/product-category`	`^4.33.1`
`spryker/product-management`	`^0.20.9`
`spryker/product-management-extension`	`^1.11.0`
`spryker-shop/quick-order-page-extension`	`^1.3.0`

1) Generate transfers and run database migration

console transfer:generate
console propel:install

2) Add configuration constants

Add the project-level constants interface to map configuration keys used by the Back Office Configuration UI:

src/Pyz/Shared/AiCommerce/AiCommerceConstants.php

<?php

declare(strict_types = 1);

namespace Pyz\Shared\AiCommerce;

use SprykerFeature\Shared\AiCommerce\AiCommerceConstants as SprykerFeatureAiCommerceConstants;

interface AiCommerceConstants extends SprykerFeatureAiCommerceConstants
{
    public const string AI_CONFIGURATION_SMART_PIM = 'AI_COMMERCE:AI_CONFIGURATION_SMART_PIM';
}

3) Configure AI models for Smart PIM

Add the Smart PIM named AI configuration entry to config/Shared/config_ai.php. The API token and model are resolved at runtime from the Back Office Configuration UI using the CONFIGURATION_REFERENCE_PREFIX:

config/Shared/config_ai.php

<?php

use Pyz\Shared\AiCommerce\AiCommerceConstants;
use Spryker\Shared\AiFoundation\AiFoundationConstants;

$openAiConfiguration = [
    'provider_name' => AiFoundationConstants::PROVIDER_OPENAI, // or any other provider name
    'provider_config' => [
        'key' => 'open-ai-api-token', // or any other configuration key
        'model' => 'gpt-4o',
    ],
];

$config[AiFoundationConstants::AI_CONFIGURATIONS][AiCommerceConstants::AI_CONFIGURATION_SMART_PIM] = $openAiConfiguration;

4) Configure Smart PIM

Override AiCommerceConfig in the Zed layer to route all Smart PIM capabilities to the AI_CONFIGURATION_SMART_PIM named configuration:

src/Pyz/Zed/AiCommerce/AiCommerceConfig.php

<?php

declare(strict_types = 1);

namespace Pyz\Zed\AiCommerce;

use Pyz\Shared\AiCommerce\AiCommerceConstants;
use SprykerFeature\Zed\AiCommerce\AiCommerceConfig as SprykerAiCommerceConfig;

class AiCommerceConfig extends SprykerAiCommerceConfig
{
    public function getContentImproverAiConfigurationName(): ?string
    {
        return AiCommerceConstants::AI_CONFIGURATION_SMART_PIM;
    }

    public function getImageAltTextAiConfigurationName(): ?string
    {
        return AiCommerceConstants::AI_CONFIGURATION_SMART_PIM;
    }

    public function getCategorySuggestionAiConfigurationName(): ?string
    {
        return AiCommerceConstants::AI_CONFIGURATION_SMART_PIM;
    }

    public function getTranslationAiConfigurationName(): ?string
    {
        return AiCommerceConstants::AI_CONFIGURATION_SMART_PIM;
    }
}

5) Set up behavior

PLUGIN	SPECIFICATION	PREREQUISITES	NAMESPACE
`ProductCategoryProductAbstractPostCreatePlugin`	Saves category assignments when an abstract product is created. Required for Smart PIM category suggestions to be persisted.		`Spryker\Zed\ProductCategory\Communication\Plugin\Product`
`ProductCategoryProductAbstractAfterUpdatePlugin`	Updates category assignments when an abstract product is updated. Required for Smart PIM category suggestions to be persisted.		`Spryker\Zed\ProductCategory\Communication\Plugin\Product`

src/Pyz/Zed/Product/ProductDependencyProvider.php

<?php

namespace Pyz\Zed\Product;

use Spryker\Zed\Product\ProductDependencyProvider as SprykerProductDependencyProvider;
use Spryker\Zed\ProductCategory\Communication\Plugin\Product\ProductCategoryProductAbstractAfterUpdatePlugin;
use Spryker\Zed\ProductCategory\Communication\Plugin\Product\ProductCategoryProductAbstractPostCreatePlugin;

class ProductDependencyProvider extends SprykerProductDependencyProvider
{
    /**
     * @return array<\Spryker\Zed\ProductExtension\Dependency\Plugin\ProductAbstractPostCreatePluginInterface>
     */
    protected function getProductAbstractPostCreatePlugins(): array
    {
        return [
            // ... other plugins
            new ProductCategoryProductAbstractPostCreatePlugin(),
        ];
    }

    /**
     * @param \Spryker\Zed\Kernel\Container $container
     *
     * @return array<\Spryker\Zed\ProductExtension\Dependency\Plugin\ProductAbstractAfterUpdatePluginInterface>
     */
    protected function getProductAbstractAfterUpdatePlugins(Container $container): array
    {
        return [
            // ... other plugins
            new ProductCategoryProductAbstractAfterUpdatePlugin(),
        ];
    }
}

PLUGIN	SPECIFICATION	PREREQUISITES	NAMESPACE
`ProductCategoryAbstractFormExpanderPlugin`	Adds the category field to the abstract product form, enabling Smart PIM to populate and display category suggestions.		`Spryker\Zed\ProductCategory\Communication\Plugin\ProductManagement`
`ProductManagementAiProductAbstractFormTabContentProviderWithPriorityPlugin`	Adds the Smart PIM AI panel as a tab content provider in the abstract product form.		`SprykerFeature\Zed\AiCommerce\Communication\Plugin\ProductManagement`

src/Pyz/Zed/ProductManagement/ProductManagementDependencyProvider.php

<?php

namespace Pyz\Zed\ProductManagement;

use Spryker\Zed\ProductManagement\ProductManagementDependencyProvider as SprykerProductManagementDependencyProvider;
use Spryker\Zed\ProductCategory\Communication\Plugin\ProductManagement\ProductCategoryAbstractFormExpanderPlugin;
use SprykerFeature\Zed\AiCommerce\Communication\Plugin\ProductManagement\ProductManagementAiProductAbstractFormTabContentProviderWithPriorityPlugin;

class ProductManagementDependencyProvider extends SprykerProductManagementDependencyProvider
{
    /**
     * @return array<\Spryker\Zed\ProductManagementExtension\Dependency\Plugin\ProductAbstractFormExpanderPluginInterface>
     */
    protected function getProductAbstractFormExpanderPlugins(): array
    {
        return [
            // ... other plugins
            new ProductCategoryAbstractFormExpanderPlugin(),
        ];
    }

    /**
     * @return array<\Spryker\Zed\ProductManagementExtension\Dependency\Plugin\ProductAbstractFormTabContentProviderWithPriorityPluginInterface>
     */
    protected function getProductAbstractFormTabContentProviderWithPriorityPlugins(): array
    {
        return [
            // ... other plugins
            new ProductManagementAiProductAbstractFormTabContentProviderWithPriorityPlugin(),
        ];
    }
}

PLUGIN	SPECIFICATION	PREREQUISITES	NAMESPACE
`AiCommerceTwigPlugin`	Registers Twig functions and variables required by Smart PIM modals on product pages.		`SprykerFeature\Zed\AiCommerce\Communication\Plugin\Twig`

src/Pyz/Zed/Twig/TwigDependencyProvider.php

<?php

namespace Pyz\Zed\Twig;

use Spryker\Zed\Twig\TwigDependencyProvider as SprykerTwigDependencyProvider;
use SprykerFeature\Zed\AiCommerce\Communication\Plugin\Twig\AiCommerceTwigPlugin;

class TwigDependencyProvider extends SprykerTwigDependencyProvider
{
    /**
     * @return array<\Spryker\Shared\TwigExtension\Dependency\Plugin\TwigPluginInterface>
     */
    protected function getTwigPlugins(): array
    {
        return [
            // ... other plugins
            new AiCommerceTwigPlugin(),
        ];
    }
}

6) Extend product management templates

Override the following product management Twig templates to include the Smart PIM AI modals partial. Each template extends its core counterpart and includes the partial in the content block:

src/Pyz/Zed/ProductManagement/Presentation/Add/index.twig

{% extends '@Spryker:ProductManagement/Add/index.twig' %}
{% block content %}
    {{ parent() }}
    {% include '@SprykerFeature:AiCommerce/SmartProductManagement/_partials/product-management-ai-modals.twig' ignore missing %}
{% endblock %}

src/Pyz/Zed/ProductManagement/Presentation/AddVariant/index.twig

{% extends '@Spryker:ProductManagement/AddVariant/index.twig' %}
{% block content %}
    {{ parent() }}
    {% include '@SprykerFeature:AiCommerce/SmartProductManagement/_partials/product-management-ai-modals.twig' ignore missing %}
{% endblock %}

src/Pyz/Zed/ProductManagement/Presentation/Edit/index.twig

{% extends '@Spryker:ProductManagement/Edit/index.twig' %}
{% block content %}
    {{ parent() }}
    {% include '@SprykerFeature:AiCommerce/SmartProductManagement/_partials/product-management-ai-modals.twig' ignore missing %}
{% endblock %}

src/Pyz/Zed/ProductManagement/Presentation/Edit/variant.twig

{% extends '@Spryker:ProductManagement/Edit/variant.twig' %}
{% block content %}
    {{ parent() }}
    {% include '@SprykerFeature:AiCommerce/SmartProductManagement/_partials/product-management-ai-modals.twig' ignore missing %}
{% endblock %}

Verification

In the Back Office, open a product create or edit page. Make sure the Smart PIM AI panel is visible in the product form.

7) Sync configuration and build frontend assets

Sync the AI Commerce configuration to the database and build frontend assets:

console configuration:sync
console frontend:project:install-dependencies
console frontend:zed:build
console twig:cache:warmer

8) Configure OpenAI settings

Set the OpenAI API credentials and model settings in the Back Office:

In the Back Office, go to AI Commerce > Open AI.
Enter the OpenAI API Token.
Set the OpenAI Default Model (default: gpt-4o) and OpenAI Smart Model (default: gpt-4.1).
Click Save.