Spryker Documentation

Eco modules

Thu, 19 Feb 2026 09:02:00 +0000

Spryker Commerce OS is known for its modular architecture, designed for flexibility and the ability to handle complex ecommerce requirements. While the core platform provides essential ecommerce functions, modern online businesses often need to connect with various specialized third-party services to create a complete solution. These external services can include payment gateways, Product Information Management systems, monitoring tools, analytics platforms, and more.

Eco modules are the specific components within the Spryker ecosystem designed precisely for this purpose: integrating these third-party technologies.

Overview of Eco modules

Eco Modules are essential building blocks for extending the Spryker Commerce OS, enabling businesses to integrate seamlessly with external systems and services.

At their core, Eco modules act as connectors or adapters. They bridge the functionality of Spryker Commerce OS with third-party systems and services, empowering your platform to handle tasks like payment processing, product information management, and system monitoring without needing to reinvent the wheel.

For instance, instead of building a custom payment integration from scratch, you can leverage the Spryker Eco Module for Adyen to handle payments reliably and securely.

Location of Eco modules

Understanding where Eco modules live in your project directory is key to maintaining a clean and organized codebase. You’ll find them under the vendor/spryker-eco/ directory, which distinguishes them from:

Spryker Core Modules: Located under vendor/spryker/, these are the essential building blocks of the Spryker OS.
Project Specific Code: Usually found in src/Pyz/, this is where your team implements customizations and business logic tailored to your project.

This clear separation helps developers navigate the project more efficiently and keeps external integrations modular and easy to manage.

Installation of Eco modules

Eco Modules are installed using Composer, just like other dependencies in a PHP project. They follow a consistent naming convention, using the spryker-eco/ prefix in their package names. For example:

spryker-eco/adyen
spryker-eco/akeneo-connector

This naming standard makes it easy to identify Eco modules and differentiate them from core packages or other vendor dependencies.

Eco module examples

The functionality of Eco modules is diverse, enabling Spryker applications to harness the power of external partners and services. Common use cases include:

Payment: Processing payments through providers like Adyen or CrefoPay.
Product information management: Synchronizing product data with solutions like Akeneo.
Monitoring: Sending performance data to services like New Relic for tracking and analysis.

These modules simplify the integration of powerful external tools, saving development time and reducing the risk of errors that can come with custom implementations.

Relationship to Spryker core code

Although Eco modules are distributed separately from the Spryker core, they’re designed to integrate seamlessly. They leverage Spryker’s standardized extension mechanisms, including plugins and dependency providers, making them as extensible and customizable as the core modules themselves.

This consistent approach means you can treat Eco modules like any other Spryker module, adapting or extending them to meet your project’s specific needs.

Using Eco modules

In essence, Eco modules provide a standardized and maintainable way to enhance Spryker by connecting it to the broader technology ecosystem. They empower businesses to build tailored, best of breed solutions that combine the strength of Spryker with the capabilities of leading third-party services.

With Eco Modules, you’re not limited by what’s built into the Spryker core – you can tap into a world of possibilities, driving innovation and differentiation in your ecommerce platform.

Disclaimer

Eco modules that have been built are there as an example, they may not be fully up to date and may need work to integrate them in to your Spryker Project. Eco modules are not part of the paid Spryker Products or Services. Customers cannot claim maintenance of or updates for Eco Modules. Spryker cannot be held liable for any use of this kind of integration.

Community contributions

Thu, 19 Feb 2026 09:02:00 +0000

Connect, create, contribute.

Spryker thrives because of its powerful technology and the people who build on it. Discover how community driven innovation can accelerate your next project.

Explore developer driven tools and extensions that boost your Spryker project. Brought to you by the community, for the community.

Browse community tools

Overview

Community contributions are open-source tools, extensions, and enhancements shared by developers, partners, and agencies across the Spryker ecosystem. They help you with the following:

Solve real world challenges
Speed up development
Improve platform capabilities

Examples include:

CLI utilities for automation
Monitoring and debugging tools
Payment and service integrations
Productivity boosters for dev teams

Business benefits

Faster time to market

Use ready-made tools instead of building from scratch

Lower engineering overhead

Focus your team on core logic, not reinventing solutions

Higher developer efficiency

Improve workflows, speed up testing, and debug faster

Battle-tested solutions

Tools built by real Spryker practitioners for real projects

Discover contributions

All contributions are owned and maintained by their creators—but we’ve curated and categorized them for easy discovery on CommerceQuest.

Look for tools by the following:

Tags, such as cli, monitoring, payment, or ai
Partner or agency name
License type, mostly MIT

Start exploring now → Community Tools on CommerceQuest

Contributing

Have you built something useful for Spryker?

Share it with the community and help other teams go further, faster. Submit your tool via the Community Forum.

Every contribution strengthens the Spryker ecosystem.

Spryker App Composition Platform

Thu, 19 Feb 2026 09:02:00 +0000

What is the App Composition Platform

As part of its Composable Commerce approach Spryker offers the App Composition Platform (ACP) to help the modern enterprise to build and deliver any digital business model at the lowest effort.

ACP is designed to help businesses easily connect, configure, and use third party services, all without the need for complex custom development. Whether you’re looking to integrate payments, tax management, search functionality, or marketing tools, ACP makes it possible to do so with minimal effort and maximum flexibility.

ACP enables a composable approach to digital commerce choosing the ‘best of breed’ services for each part of your business. With ACP, you can add new capabilities quickly and easily, accelerating your time to market and keeping your platform flexible and scalable.

How does ACP work

Getting started with ACP is straightforward.

Ensure that your Spryker Commerce OS project is registered with ACP. Check directly with your customer service manager if you are unsure. Then simply head to the Apps section in your Back Office. There, you’ll find a variety of applications designed to enhance your commerce platform. With just a few clicks, you can connect a new service—like adding Stripe for global payments or Algolia for advanced search.

Here’s how it works:

Ensure ACP is enabled to your project: Talk to your CSM for any additional action this may need.
Browse the App Catalog: Explore a range of third party services and integrations available in the ACP catalog. Each app comes with an easy to understand description, helping you decide which one is right for your business needs.
Order the ACP App: contact your CSM for the required ordering process. You can also proceed with activating the service of the respective provider and receive your credentials.
Connect and Configure: Once you’ve chosen an app and have your service credentials, simply click to connect. Spryker handles the technical setup, so you don’t need to worry about complex coding. We provide all the tools you need to configure the app to fit your specific requirements. Note: some applications may require the installation of specific modules. You can find those in the app information page.
Seamless Integration: After connecting the app, ACP ensures smooth integration with your Spryker platform, handling everything from API configurations to data syncing. Our secure infrastructure guarantees that everything works seamlessly and reliably.
Automatic Updates: All apps on the platform are managed and maintained by Spryker. This means you’ll always have the latest features, security updates, and improvements without any extra effort on your part.

Benefits of ACP

Speed and agility

ACP empowers your business to respond to market changes quickly. You can roll out new features or scale your platform faster than ever before. Imagine the ability to activate a new payment provider or add advanced search in a fraction of the time it would traditionally take.

Flexibility and scalability

As your business grows, ACP scales with you. You can easily swap out existing apps, add new ones, or configure different services to meet your changing needs, all without disrupting your entire platform. This flexibility ensures you're always using the best tools for your business.

Composable architecture

ACP leverages Spryker's headless, API first architecture, which means you can integrate services with low code. This composable approach allows you to mix and match the best apps for each part of your business, giving you the freedom to create a solution that fits your unique needs.

Security and compliance

With Spryker managing the backend infrastructure, you can trust that every app in ACP is fully vetted, secure, and compliant. We take care of the technical details so you don't have to, from API security to compliance with the latest regulations.

Why choose ACP

ACP is built to make your business more agile, secure, and scalable. By allowing you to connect to a growing catalog of third party services without the need for complex coding, ACP empowers you to innovate faster and stay ahead of the competition. Whether you’re a business user looking for simplicity or a developer needing flexibility, ACP makes it easier than ever to enhance your platform and scale your digital commerce strategy.

ACP Apps

Run the docs locally

Wed, 18 Feb 2026 14:58:02 +0000

This document describes how to run Spryker docs locally using Docker. You may want to run docs locally to preview your changes, but it's not required for contributing. For instructions on contributing, see [Edit the docs locally](/docs/about/all/about-the-docs/contribute-to-the-docs/edit-the-docs-locally.html) ## Prerequisites 1. Create an account on [GitHub](https://github.com/). 2. Install [GitHub Desktop](https://desktop.github.com/). 3. Install [Docker Desktop](https://www.docker.com/products/docker-desktop/). 4. Clone the [Spryker docs repository](https://github.com/spryker/spryker-docs). For detailed instructions, see [Clone the Spryker docs repository](https://docs.spryker.com/docs/about/all/about-the-docs/contribute-to-the-docs/edit-the-docs-locally.html#clone-the-spryker-docs-repository). ## Run the docs 1. In Docker Desktop, click **>_Terminal**. 2. In terminal, go to the `spryker-docs` directory. If you didn't change the default path when cloning the repository, the command to do it looks as follows: ```bash cd Documents/GitHub/spryker-docs ``` 3. Run the docs: ```bash docker compose up ``` The first launch can take up to 15 minutes. When the build is done, you should see a message that the server is running and its local address. You can access the local copy of Spryker docs by opening `http://localhost:4000` in your browser. If you update a file in the repository, it will be automatically refreshed so you can see it on your local website.

B2C Suite

Wed, 18 Feb 2026 14:58:02 +0000

The Spryker B2С Suite is a collection of ready-to-use B2С-specific features. Of course, every B2С project has its own set of features that meet its business needs and B2B features can be used as well, but the most common features for B2C commerce are as follows.

B2C feature list

B2C Demo Shop

To demonstrate the B2C features in a live implementation, we use a B2C Demo Shop. The B2C Demo Shop is a showcase that is preloaded with a combination of modules and functionalities best suited for B2C commerce. This Demo Shop is our recommended starting point for all standard B2C commerce projects. New features for the B2C Demo Shop are released every several months.

To download the B2C Demo Shop, visit the following GitHub repository: https://github.com/spryker-shop/b2c-demo-shop.

To install the B2C Demo Shop, follow the instructions in Installing Spryker with Docker.

About Spryker docs

Wed, 18 Feb 2026 14:58:02 +0000

Spryker docs are your one-stop hub for all the information about Spryker Cloud Commerce OS.

The source of truth

When it comes to knowledge sharing, we rely on the docs as the main source of truth. Both external and internal users refer to the docs when developing projects, designing Spryker Safari courses, creating new or customizing the existing functionality.

Owned by the Spryker community

The expertise in Spryker is shared among the many engineers and entrepreneurs creating all sorts of projects based on Spryker. That’s why the docs are open to any type of contribution: from simple bug fixes to sharing how you managed to solve a complex problem or build around an interesting use case.

What’s in the docs

The docs are focused on covering all the functionality that comes with Spryker and how to build projects with that functionality. Because the docs are community-owned, the content adapts to the users’ demands. If you don’t find the information you are looking for, feel free to create an issue and we will look into covering the topic. Or ask the Spryker community at CommerceQuest.

Next step

Contribute to the docs

Install the Product Availability Display feature

Wed, 18 Feb 2026 11:22:42 +0000

Use this guide to install the Product Availability Display feature. ## Prerequisites Install the following required features: | NAME | VERSION | INSTALLATION GUIDE | |------|---------|-------------------| | Spryker Core | {{site.version}} | [Install the Spryker Core feature](/docs/pbc/all/miscellaneous/{{site.version}}/install-and-upgrade/install-features/install-the-spryker-core-feature.html) | | Product | {{site.version}} | [Install the Product feature](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-product-feature.html) | | Cart | {{site.version}} | [Install the Cart feature](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-cart-feature.html) | ## 1. Install the required modules Install the required modules using Composer: ```bash composer require spryker-feature/inventory-management:"dev-master" --update-with-dependencies ``` {% info_block warningBox "Verification" %} Make sure the following modules have been installed: | MODULE | EXPECTED DIRECTORY | |--------|-------------------| | AvailabilityWidget | vendor/spryker-shop/availability-widget | | AvailabilityWidgetExtension | vendor/spryker-shop/availability-widget-extension | | AvailabilityCartConnector | vendor/spryker/availability-cart-connector | | AvailabilityStorage | vendor/spryker/availability-storage | {% endinfo_block %} ## 2. Set up configuration Add the following configuration to your project: ### Yves configuration **src/Pyz/Yves/AvailabilityWidget/AvailabilityWidgetConfig.php** ```php */ protected function getExpanderPlugins(Container $container): array { return [ new AvailabilityItemExpanderPlugin(), ]; } } ``` {% info_block warningBox "Verification" %} Make sure that `AvailabilityItemExpanderPlugin` is registered by adding a product to the cart and verifying that `ItemTransfer.stockQuantity` and `ItemTransfer.isNeverOutOfStock` are populated. {% endinfo_block %} **src/Pyz/Client/ProductStorage/ProductStorageDependencyProvider.php** ```php */ protected function getProductViewExpanderPlugins(): array { return [ new ProductViewAvailabilityStorageExpanderPlugin(), ]; } } ``` {% info_block warningBox "Verification" %} Make sure that `ProductViewAvailabilityStorageExpanderPlugin` is registered by viewing a product detail page and verifying that `ProductViewTransfer.stockQuantity` and `ProductViewTransfer.isNeverOutOfStock` are populated. {% endinfo_block %} **src/Pyz/Yves/ShopApplication/ShopApplicationDependencyProvider.php** ```php */ protected function getGlobalWidgets(): array { return [ ProductAvailabilityWidget::class, ]; } } ``` {% info_block warningBox "Verification" %} Make sure that `ProductAvailabilityWidget` is registered by checking that the availability widget appears on product detail pages and in the shopping cart. {% endinfo_block %} ## 5. Set up templates Enable `ProductAvailabilityWidget` in the frontend templates. ### Product detail page template Add the availability widget to the product detail page: **src/Pyz/Yves/ProductDetailPage/Theme/default/components/molecules/product-configurator/product-configurator.twig** ```twig {% raw %} {% extends molecule('product-configurator', '@SprykerShop:ProductDetailPage') %} {% set isProductConcrete = data.product.idProductConcrete is not empty %} {% set showProductAvailability = isProductConcrete %} {% block body %} {# ... existing code ... #} {% set productAvailabilityWidget = findWidget('ProductAvailabilityWidget', [ data.product ]) %} {% if showProductAvailability %} {% if productAvailabilityWidget is not empty %} {% widget productAvailabilityWidget only %}{% endwidget %} {% endif %} {% endif %} {# ... existing code ... #} {% widget 'AddToCartFormWidget' args [config, data.product, isDisabled, options] with { data: { isService: sspServiceDetectorWidget and sspServiceDetectorWidget.isService, } } only %} {% block embeddedData %} {# ... existing code ... #} {# Remove the following block if it exists: #} {# {% if not data.product.available %} #} {#

#} {# {% endif %} #} {% endblock %} {% endwidget %} {# ... rest of the template ... #} {% endblock %} {% endraw %} ``` ### Product catalog template Add the availability widget to product cards in the catalog: **src/Pyz/Yves/ShopUi/Theme/default/components/molecules/product-card-item/product-card-item.twig** ```twig {% raw %} {% extends model('component') %} {% block body %} {# ... existing code ... #} {% block productInfo %} {# ... existing code ... #} {% block availability %} {% set productAvailabilityWidget = findWidget('ProductAvailabilityWidget', [ listItem ]) %} {% if productAvailabilityWidget is not empty %} {% widget productAvailabilityWidget %}{% endwidget %} {% endif %} {% endblock %} {# ... rest of the template ... #} {% endblock %} {% endblock %} {% endraw %} ``` {% info_block warningBox "Verification" %} Make sure the availability widget displays correctly: - On product detail pages, the widget appears below the product title and shows stock information - In product catalogs and search results, each product card displays availability information - The display format matches your configuration (indicator only or indicator with quantity) {% endinfo_block %} ## 6. Optional: Add measurement unit support To display stock quantities with measurement units like "250 kg in stock", install additional modules and register plugins. ### Install measurement unit modules ```bash composer require spryker-feature/measurement-units:"{{site.version}}" --update-with-dependencies ``` {% info_block warningBox "Verification" %} Make sure the following modules have been installed: | MODULE | EXPECTED DIRECTORY | |--------|-------------------| | ProductMeasurementUnitWidget | vendor/spryker-shop/product-measurement-unit-widget | | ProductMeasurementUnitStorage | vendor/spryker/product-measurement-unit-storage | {% endinfo_block %} ### Register measurement unit plugins **src/Pyz/Yves/AvailabilityWidget/AvailabilityWidgetDependencyProvider.php** ```php */ protected function getAvailabilityQuantityFormatterStrategyPlugins(): array { return [ new ProductMeasurementUnitQuantityFormatterStrategyPlugin(), ]; } } ``` Add `ProductViewMeasurementUnitExpanderPlugin` to the existing `ProductStorageDependencyProvider`: **src/Pyz/Client/ProductStorage/ProductStorageDependencyProvider.php** ```php */ protected function getProductViewExpanderPlugins(): array { return [ new ProductViewAvailabilityStorageExpanderPlugin(), new ProductViewMeasurementUnitExpanderPlugin(), // Add this line ]; } } ``` {% info_block infoBox "Info" %} `ProductViewMeasurementUnitExpanderPlugin` requires the `spryker/product-measurement-unit-storage` module from step 6. {% endinfo_block %} {% info_block warningBox "Verification" %} Make sure that measurement units appear in availability displays by viewing a product that has a base measurement unit configured. The availability should display as "[quantity] [unit] in stock", for example, "250 kg in stock". {% endinfo_block %} ## 7. Import glossary data Import glossary keys for availability translations: **data/import/common/common/glossary.csv** ```csv product.availability.available,Available,en_US product.availability.available,Verfügbar,de_DE product.availability.in_stock,"%number% in stock",en_US product.availability.in_stock,"%number% auf Lager",de_DE product.availability.out_of_stock,"Out of stock",en_US product.availability.out_of_stock,"Nicht auf Lager",de_DE ``` Run the data import: ```bash console data:import glossary ``` {% info_block warningBox "Verification" %} Make sure the glossary keys have been imported by checking the `spy_glossary_key` and `spy_glossary_translation` tables. Verify that the availability widget displays the correct translations on the storefront. {% endinfo_block %} ## 8. Optional: Import measurement unit translations If you enabled measurement unit support, import glossary keys for measurement unit names: **data/import/common/common/glossary.csv** ```csv measurement_units.item.name.short,pc,en_US measurement_units.item.name.short,Stk,de_DE measurement_units.standard.weight.kilo.name.short,kg,en_US measurement_units.standard.weight.kilo.name.short,kg,de_DE measurement_units.standard.weight.gram.name.short,g,en_US measurement_units.standard.weight.gram.name.short,g,de_DE measurement_units.standard.weight.tone.name.short,t,en_US measurement_units.standard.weight.tone.name.short,t,de_DE measurement_units.standard.weight.gbou.name.short,oz,en_US measurement_units.standard.weight.gbou.name.short,oz,de_DE measurement_units.standard.weight.usou.name.short,oz,en_US measurement_units.standard.weight.usou.name.short,oz,de_DE measurement_units.standard.weight.pund.name.short,lb,en_US measurement_units.standard.weight.pund.name.short,lb,de_DE measurement_units.standard.weight.huwg.name.short,GB cwt,en_US measurement_units.standard.weight.huwg.name.short,GB cwt,de_DE measurement_units.standard.weight.gbtn.name.short,GB ton,en_US measurement_units.standard.weight.gbtn.name.short,GB ton,de_DE measurement_units.standard.weight.ustn.name.short,US ton,en_US measurement_units.standard.weight.ustn.name.short,US ton,de_DE measurement_units.standard.weight.oztr.name.short,ozt,en_US measurement_units.standard.weight.oztr.name.short,ozt,de_DE measurement_units.standard.weight.ucwt.name.short,US cwt,en_US measurement_units.standard.weight.ucwt.name.short,US cwt,de_DE measurement_units.standard.length.metr.name.short,m,en_US measurement_units.standard.length.metr.name.short,m,de_DE measurement_units.standard.length.cmet.name.short,cm,en_US measurement_units.standard.length.cmet.name.short,cm,de_DE measurement_units.standard.length.mmet.name.short,mm,en_US measurement_units.standard.length.mmet.name.short,mm,de_DE measurement_units.standard.length.kmet.name.short,km,en_US measurement_units.standard.length.kmet.name.short,km,de_DE measurement_units.standard.length.inch.name.short,in,en_US measurement_units.standard.length.inch.name.short,in,de_DE measurement_units.standard.length.yard.name.short,yd,en_US measurement_units.standard.length.yard.name.short,yd,de_DE measurement_units.standard.length.foot.name.short,ft,en_US measurement_units.standard.length.foot.name.short,ft,de_DE measurement_units.standard.length.mile.name.short,mi,en_US measurement_units.standard.length.mile.name.short,mi,de_DE measurement_units.standard.area.smet.name.short,m²,en_US measurement_units.standard.area.smet.name.short,m²,de_DE measurement_units.standard.area.sqki.name.short,km²,en_US measurement_units.standard.area.sqki.name.short,km²,de_DE measurement_units.standard.area.smil.name.short,mm²,en_US measurement_units.standard.area.smil.name.short,mm²,de_DE measurement_units.standard.area.scmt.name.short,cm²,en_US measurement_units.standard.area.scmt.name.short,cm²,de_DE measurement_units.standard.area.sqin.name.short,in²,en_US measurement_units.standard.area.sqin.name.short,in²,de_DE measurement_units.standard.area.sqfo.name.short,ft²,en_US measurement_units.standard.area.sqfo.name.short,ft²,de_DE measurement_units.standard.area.sqmi.name.short,mi²,en_US measurement_units.standard.area.sqmi.name.short,mi²,de_DE measurement_units.standard.area.sqya.name.short,yd²,en_US measurement_units.standard.area.sqya.name.short,yd²,de_DE measurement_units.standard.area.acre.name.short,ac,en_US measurement_units.standard.area.acre.name.short,ac,de_DE measurement_units.standard.area.ares.name.short,a,en_US measurement_units.standard.area.ares.name.short,a,de_DE measurement_units.standard.area.hect.name.short,ha,en_US measurement_units.standard.area.hect.name.short,ha,de_DE measurement_units.standard.litr.name.short,L,en_US measurement_units.standard.litr.name.short,L,de_DE measurement_units.standard.celi.name.short,cL,en_US measurement_units.standard.celi.name.short,cL,de_DE measurement_units.standard.mili.name.short,mL,en_US measurement_units.standard.mili.name.short,mL,de_DE measurement_units.standard.gbga.name.short,GB gal,en_US measurement_units.standard.gbga.name.short,GB gal,de_DE measurement_units.standard.gbpi.name.short,GB pt,en_US measurement_units.standard.gbpi.name.short,GB pt,de_DE measurement_units.standard.uspi.name.short,US pt,en_US measurement_units.standard.uspi.name.short,US pt,de_DE measurement_units.standard.gbqa.name.short,GB qt,en_US measurement_units.standard.gbqa.name.short,GB qt,de_DE measurement_units.standard.usqa.name.short,US qt,en_US measurement_units.standard.usqa.name.short,US qt,de_DE measurement_units.standard.usga.name.short,US gal,en_US measurement_units.standard.usga.name.short,US gal,de_DE measurement_units.standard.barl.name.short,bbl,en_US measurement_units.standard.barl.name.short,bbl,de_DE measurement_units.standard.bcuf.name.short,BCF,en_US measurement_units.standard.bcuf.name.short,BCF,de_DE measurement_units.standard.bdft.name.short,BF,en_US measurement_units.standard.bdft.name.short,BF,de_DE measurement_units.standard.cbme.name.short,m³,en_US measurement_units.standard.cbme.name.short,m³,de_DE measurement_units.standard.miba.name.short,MMbbl,en_US measurement_units.standard.miba.name.short,MMbbl,de_DE measurement_units.standard.dgeu.name.short,DGE,en_US measurement_units.standard.dgeu.name.short,DGE,de_DE measurement_units.standard.ggeu.name.short,GGE,en_US measurement_units.standard.ggeu.name.short,GGE,de_DE measurement_units.standard.busl.name.short,bu,en_US measurement_units.standard.busl.name.short,bu,de_DE ``` Run the data import: ```bash console data:import glossary ``` ## 9. Set up frontend Build the frontend to include the new styles and assets: ```bash console frontend:yves:build ```

Install the Buy Box feature

Wed, 18 Feb 2026 11:22:42 +0000

Use this guide to install the Buy Box feature for marketplace scenarios. ## Prerequisites Install the following required features: | NAME | VERSION | INSTALLATION GUIDE | |------|---------|-------------------| | Spryker Core | {{site.version}} | [Install the Spryker Core feature](/docs/pbc/all/miscellaneous/{{site.version}}/install-and-upgrade/install-features/install-the-spryker-core-feature.html) | | Product | {{site.version}} | [Install the Product feature](/docs/pbc/all/product-information-management/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-product-feature.html) | | Cart | {{site.version}} | [Install the Cart feature](/docs/pbc/all/cart-and-checkout/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-cart-feature.html) | | Marketplace Product | {{site.version}} | [Install the Marketplace Product feature](/docs/pbc/all/product-information-management/{{site.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-feature.html) | | Marketplace Product Offer | {{site.version}} | [Install the Marketplace Product Offer feature](/docs/pbc/all/offer-management/{{site.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-feature.html) | | Marketplace Inventory Management | {{site.version}} | [Install the Marketplace Inventory Management feature](/docs/pbc/all/warehouse-management-system/{{site.version}}/marketplace/install-features/install-the-marketplace-inventory-management-feature.html) | | Marketplace Merchant | {{site.version}} | [Install the Marketplace Merchant feature](/docs/pbc/all/merchant-management/{{site.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-feature.html) | ## 1. Install the required modules Install the required modules by using Composer: ```bash composer require spryker-feature/buy-box:"dev-master" --update-with-dependencies ``` {% info_block warningBox "Verification" %} Make sure the following modules have been installed: | MODULE | EXPECTED DIRECTORY | |--------|-------------------| | BuyBox | vendor/spryker-feature/buy-box | {% endinfo_block %} ## 2. Set up configuration Add the following configuration to your project: **src/Pyz/Yves/BuyBox/BuyBoxConfig.php** ```php */ protected function getGlobalWidgets(): array { return [ BuyBoxWidget::class, ]; } } ``` {% info_block warningBox "Verification" %} Make sure that `BuyBoxWidget` is registered by checking that the buy box appears on product detail pages in marketplace mode with multiple merchant offers. {% endinfo_block %} ## 5. Set up templates Integrate the BuyBoxWidget into the product detail page template. **src/Pyz/Yves/ProductDetailPage/Theme/default/components/molecules/product-configurator/product-configurator.twig** ```twig {% raw %} {% extends molecule('product-configurator', '@SprykerShop:ProductDetailPage') %} {% set isProductConcrete = data.product.idProductConcrete is not empty %} {% set buyBoxWidget = findWidget('BuyBoxWidget', [data.product, app.request]) %} {% set productOffersCount = buyBoxWidget.products | length %} {% set showProductAvailability = isProductConcrete and productOffersCount == 0 %} {% set isAvailable = isProductConcrete and (data.product.available or productOffersCount) %} {% block body %} {# ... existing code ... #} {% widget 'AddToCartFormWidget' args [config, data.product, isDisabled, options] with { data: { isService: sspServiceDetectorWidget and sspServiceDetectorWidget.isService, }, embed: { showProductAvailability: showProductAvailability, buyBoxWidget: buyBoxWidget, }, } only %} {% block embeddedData %} {# ... existing code ... #} {% if not shipmentTypeServicePointSelectorWidget or not shipmentTypeServicePointSelectorWidget.hasShipmentTypeWithRequiredLocation %}

{% widget embed.buyBoxWidget %} {% block content %} {{ parent() }} {% endblock %} {% endwidget %}

{% endif %} {# ... rest of the template ... #} {% endblock %} {% endwidget %} {# ... rest of the template ... #} {% endblock %} {% endraw %} ``` {% info_block infoBox "Template change summary" %} This template change: - Calculates `productOffersCount` by using the `BuyBoxWidget`. - Sets `showProductAvailability` so availability displays only when no product offers exist. - Passes `buyBoxWidget` through the embed context to render it within `AddToCartFormWidget`. - Replaces the default merchant product widgets with the unified `BuyBoxWidget` display. {% endinfo_block %} {% info_block warningBox "Verification" %} Make sure the Buy Box displays correctly on product detail pages: - When multiple merchant offers exist, the Buy Box shows all available offers. - Each offer displays merchant information and price. - You can select different merchant offers. - When no product offers exist, availability information displays instead. {% endinfo_block %} ## 6. Import glossary data Import glossary keys for buy box translations: **data/import/common/common/glossary.csv** ```csv buy_box.sold_by,"Sold by",en_US buy_box.sold_by,"Verkauft von",de_DE buy_box.view_merchant,"View seller",en_US buy_box.view_merchant,"Händler ansehen",de_DE ``` Run the data import: ```bash console data:import glossary ``` {% info_block warningBox "Verification" %} Make sure the glossary keys have been imported by checking the `spy_glossary_key` and `spy_glossary_translation` tables. Verify that the buy box displays the correct translations on the storefront. {% endinfo_block %} ## 7. Set up frontend Build the frontend to include the new styles and assets: ```bash console frontend:yves:build ``` ## 8. Optional: Add stock-based sorting and availability per offer To enable stock-based sorting and show availability per merchant offer, install the Product Availability Display feature and configure the integration. ### Install Product Availability Display feature Follow the [Install the Product Availability Display feature](/docs/pbc/all/warehouse-management-system/latest/base-shop/install-and-upgrade/install-features/install-the-product-availability-display-feature.html) guide to install the availability modules. ### Add availability to product offers Register the plugin that adds availability data to product offers: **src/Pyz/Client/ProductOfferStorage/ProductOfferStorageDependencyProvider.php** ```php */ protected function getProductOfferStorageBulkExpanderPlugins(): array { return [ new ProductOfferAvailabilityProductOfferStorageBulkExpanderPlugin(), ]; } } ``` {% info_block warningBox "Verification" %} Make sure that `ProductOfferAvailabilityProductOfferStorageBulkExpanderPlugin` is registered by viewing a product with multiple merchant offers and verifying that each offer displays its own availability information. {% endinfo_block %} ### Configure stock-based sorting To sort offers by stock instead of price, update your Buy Box configuration (from step 2) to use `SORT_BY_STOCK`: **src/Pyz/Yves/BuyBox/BuyBoxConfig.php** ```php public function getSortingStrategy(): string { return static::SORT_BY_STOCK; // Sort by highest to lowest stock } ``` This enables stock-aware Buy Box functionality with per-offer availability and stock-based sorting.

Product Availability Display feature overview

Tue, 17 Feb 2026 17:23:54 +0000

The Product Availability Display feature shows stock quantities on product detail pages, in shopping carts, and in the Buy Box in marketplace scenarios. When you enable the feature, availability displays in three states: in stock with quantity, available (for never-out-of-stock products), or out of stock. ## Display modes The feature supports two display modes: **Indicator only**: Shows the availability status without quantities. Products display as "Available" or "Out of stock." **Indicator with quantity**: Shows the availability status with exact quantities. Products display as "19 in stock" or "Out of stock." ## Stock display on product detail page Availability information appears on product detail pages for concrete products (specific product variants). When a product has available inventory, the system displays the quantity. The format is "X in stock," for example, "19 in stock." ### Never-out-of-stock products Products marked as never out of stock display "Available" without showing a quantity. These products remain available regardless of inventory levels. ### Out of stock When a product has zero available inventory and is not marked as never out of stock, the system displays "Out of stock". ### Dynamic updates with variant selection When customers select different product variants, such as color or size, the availability display updates automatically to show stock for the selected variant. ## Stock display in shopping cart Availability information appears for each line item in the shopping cart. Each cart item displays its current availability status, for example "19 in stock" or "Available". If stock levels change after a customer adds items to the cart and before checkout, the cart display reflects the current availability. The system validates stock availability during checkout. If the requested quantity exceeds the available stock, checkout cannot be completed until the customer adjusts the order. ## Measurement unit support When products have measurement units configured, availability displays with the unit. For example, "225.5 m in stock" instead of "225.5 in stock." The measurement unit is appended to the quantity based on the product's configured base unit. ## Stock display in Buy Box In marketplace scenarios, when combined with the Buy Box feature, availability information appears per merchant offer. Customers can see stock availability for each merchant selling the product. For details about Buy Box integration, see [Buy Box feature overview](/docs/pbc/all/offer-management/latest/marketplace/buy-box-feature-overview.html). ## Configuration You configure the Product Availability Display feature at the code level. The following configuration options are available: - **Enable or disable stock display**: The feature is disabled by default. - **Display mode**: Indicator only or indicator with quantity. - **Decimal precision**: Number of decimal places for quantities (default: 2). For configuration details, see [Install the Product Availability Display feature](/docs/pbc/all/warehouse-management-system/latest/base-shop/install-and-upgrade/install-features/install-the-product-availability-display-feature.html). ## Use cases Use this feature when: - Customers need to see stock quantities to plan purchases - Customers need to verify availability before ordering - Multiple merchants sell the same product and stock varies by merchant (marketplace scenarios) - Products are sold in measurement units and quantities need to display with units ## Limitations - Reserved or allocated stock is not shown separately. - Backorder management and pre-orders are not supported. - Per-warehouse availability is not displayed to customers. - Restock notifications are not provided. - Inventory forecasting and expected restock dates are not shown. ## Related documents - [Install the Product Availability Display feature](/docs/pbc/all/warehouse-management-system/latest/base-shop/install-and-upgrade/install-features/install-the-product-availability-display-feature.html)

Buy Box feature overview

Tue, 17 Feb 2026 17:23:54 +0000

The Buy Box feature displays multiple merchant offers for the same product on the product detail page in a marketplace environment. When multiple merchants sell the same product, the Buy Box shows all available offers. This lets you compare prices and availability and select the merchant you want to purchase from.

Buy Box display

The Buy Box appears on the product detail page and presents merchant offers in a structured list.

Merchant offer information

Each offer in the Buy Box displays the following information:

Merchant name with a link to the merchant profile page
Product price offered by the merchant
Radio button for merchant selection
Availability status (when the Product Availability Display feature is installed)

Merchant selection

You select your preferred merchant using radio buttons. Only one merchant can be selected at a time. When you add the product to the cart, the selected merchant’s offer is added.

The first offer in the list is selected by default. The default selection depends on the configured sorting strategy.

URL-based merchant selection

The Buy Box supports URL parameters that let you preselect a specific merchant offer. When the URL contains a merchant selection parameter, the corresponding offer is selected instead of the default offer.

Sorting strategies

You can sort offers in the Buy Box by the following criteria:

Price: Lowest to highest (default)
Stock availability: Highest to lowest stock quantity (requires the Product Availability Display feature)

When you sort by stock availability, merchants marked as never out of stock appear first, followed by merchants with the highest stock quantities.

The sorting strategy determines which offer is pre-selected by default when customers first view the product page.

Integration with Product Availability Display

When the Product Availability Display feature is installed, the Buy Box shows availability information for each merchant offer. This lets you compare prices and stock availability across merchants.

For details about availability display, see Product Availability Display feature overview.

Configuration

You can configure the Buy Box feature at the code level. The following configuration option is available:

Sorting strategy: by price or by stock availability

For configuration details, see Install the Buy Box feature.

Use cases

Use the Buy Box feature in the following scenarios:

Multiple merchants sell the same product in a marketplace
Customers need to compare offers from different merchants
Merchant selection should be visible and explicit on the product page

Current constraints

Merchant ratings or reviews are not displayed within the Buy Box. Links to merchant profiles are provided.
Offers cannot be filtered based on shipping location, delivery time, or other criteria.
Shipping costs per merchant are not shown.
The feature does not provide offer recommendations based on customer preferences or purchase history.

Install the Buy Box feature