synerise/sylius-integration-plugin

Plugin allowing straightforward integration of Synerise platform in Sylius application.

v1.0.0 2025-09-29 09:17 UTC

Requires

• php: ^8.2
• anik/loguzz: ^2.2 || ^4.0
• mobiledetect/mobiledetectlib: ^4.8
• sylius/sylius: ^2.0
• synerise/php-sdk: ^0.6.1

Requires (Dev)

• behat/behat: ^3.16
• dmore/behat-chrome-extension: ^1.4
• dmore/chrome-mink-driver: ^2.9
• friends-of-behat/mink: ^1.11
• friends-of-behat/mink-browserkit-driver: ^1.6
• friends-of-behat/mink-debug-extension: ^2.1
• friends-of-behat/mink-extension: ^2.7
• friends-of-behat/page-object-extension: ^0.3
• friends-of-behat/suite-settings-extension: ^1.1
• friends-of-behat/symfony-extension: ^2.6
• friends-of-behat/variadic-extension: ^1.6
• nyholm/psr7: ^1.8
• phpspec/phpspec: ^7.5
• phpstan/phpstan: ^1.12
• phpstan/phpstan-doctrine: ^1.3
• phpstan/phpstan-webmozart-assert: ^1.2
• phpunit/phpunit: ^10.5
• robertfausk/behat-panther-extension: ^1.1
• sylius-labs/coding-standard: ^4.4
• sylius-labs/suite-tags-extension: ~0.2
• sylius/sylius-rector: ^2.0
• symfony/browser-kit: ^6.4 || ^7.1
• symfony/debug-bundle: ^6.4 || ^7.1
• symfony/dotenv: ^6.4 || ^7.1
• symfony/flex: ^2.4
• symfony/http-client: ^6.4 || ^7.1
• symfony/intl: ^6.4 || ^7.1
• symfony/maker-bundle: ^1.62
• symfony/web-profiler-bundle: ^6.4 || ^7.1
• symfony/webpack-encore-bundle: ^2.2

MIT

• sylius
• synerise
• sylius-plugin

README

Official Synerise plugin allowing configurable integration of Sylius applications with the platform. Main features include tracking customer actions (e.g. cart and transaction events) as well as data synchronisation of customers, orders and product catalog. The Synerise platform provides a variety of tools for building well-targeted and AI powered omnichannel marketing campaigns for any store.

Requirements

Plugin usage requires access to the Synerise platform. Visit the company website to learn about the platform and its numerous features. There you can find useful resources, such as case studies and use cases, or request a demo presentation.

Technical requirements

Before integration, please make sure your application meets with the following requirements:

• PHP 8.2+
• Sylius 2.x
• RabbitMQ (optional, but recommended as a message queues handler)

Installation

Plugin is available as a composer package. Its registration is handled with Symfony Flex recipe.

1. Allow Symfony contrib recipes

composer config extra.symfony.allow-contrib true

2. Include Synerise recipes repository

composer config --json --merge extra.symfony.endpoint '["https://api.github.com/repos/synerise/symfony-recipes/contents/index.json?ref=flex/main"]'

Alternatively, edit composer.json file of your application to include an endpoint of Synerise recipes repository:

    "extra": {
        "symfony": {
            "endpoint": [
                "https://api.github.com/repos/synerise/symfony-recipes/contents/index.json?ref=flex/main",
                "..."
            ]
        }
        "..."
    }

3. Install the plugin with composer

composer require synerise/sylius-integration-plugin

4. Run doctrine migrations

bin/console doctrine:migrations:migrate

Remember to use -e prod option for production environment.

5. Build assets

yarn encore dev # for development
yarn encore production # for production

6. Clear the application cache

bin/console cache:clear

Documentation

To learn how to properly configure the plugin, please head to our documentation page.

Support

In case of a bug, feature request or any trouble with the integration, visit our support page and fill in the proper form.