Spryker Documentation

Release notes 202608.0

Wed, 02 Sep 2026 08:38:25 +0000

## B2B Business-Ready Commerce Experiences ### Workflows {% include badge.html type="feature,early-access" %} This release introduces a workflows infrastructure that lets teams model and manage workflows for different business entities directly in the Back Office, without requiring code changes or deployment. It provides a reusable, auditable, and versioned workflows foundation built on top of the existing state machine engine. {% include carousel.html images=" https://d2s0ynfc62ej12.cloudfront.net/docs/About/all/releases/release-notes-202608.0.md/workflows_1.jpg||:: https://d2s0ynfc62ej12.cloudfront.net/docs/About/all/releases/release-notes-202608.0.md/workflows_2.jpg||" %} **Key capabilities:** - Create and adjust workflows directly in the Back Office, including states, transitions, events, conditions, and timeouts that define each process - Manage workflow versions and control which version is active - Monitor workflow progress across different entities, with support for project-specific requirements **Business benefits:** - Enables business teams to create and adjust workflows faster without developer involvement - Reduces duplication by replacing one-off workflow implementations with one reusable infrastructure - Improves governance through versioned definitions and controlled building blocks **Documentation:** - [Workflows feature overview](https://docs.spryker.com/docs/pbc/all/back-office/latest/base-shop/workflows-feature-overview) - [Workflows installation guide](https://docs.spryker.com/docs/dg/dev/integrate-and-configure/integrate-workflow-feature) ### Spryker Design System Storefront {% include badge.html type="improvement" %} This release extends the Spryker Design System in the storefront by modernizing the product listing page and merchant profile page. It helps create a more consistent buying journey for B2B customers while giving teams a scalable foundation for future storefront enhancements. {% include carousel.html images=" https://d2s0ynfc62ej12.cloudfront.net/docs/About/all/releases/release-notes-202608.0.md/Design_System_PLP.mp4||" %} **Key capabilities:** - Modernized product listing page based on the B2B design system - Added a reusable merchant page template for consistent merchant content - Expanded the storefront design foundation introduced in earlier design-system phases **Business benefits:** - Improves product discovery with a more consistent and efficient browsing experience - Increases storefront visual consistency for B2B buyers - Reduces future design and development effort through reusable page structures ### Recurring Orders: general availability {% include badge.html type="feature" %} Recurring Orders is now generally available. This release gives buyers real control over an upcoming order before it is placed. They can handle the exceptions that used to break a schedule f.e. swapping in a replacement when a product is discontinued, adjusting quantities, adding products that were missed and decide whether each change applies once or permanently. Budget problems can be corrected by the buyer directly rather than raised as a ticket **Key capabilities:** - Adjust an upcoming order before it is placed: replace an item that is no longer available, add or remove lines, and change quantities. - Choose whether a change applies to the next delivery only or to every delivery from now on. - Move an order to a different budget or cost center without cancelling the schedule. - Resolve an order that is in review because of an exceeded budget. - Proactively editing for Schedule Name, Frequency, Budget & Cost Center, Next Execution date - Run schedules with up to 200 line items, at the speed buyers expect across list, overview, and review screens. **Business benefits:** - Supply continuity. A missed replenishment can stop a production line. Schedules that survive real-world exceptions keep materials arriving without anyone watching the calendar. - Procurement capacity freed up. Repeat orders are already-made decisions. Automating them lets buyers spend their time on sourcing, not re-keying the same basket. - Spend stays inside the guardrails. Budget and cost center governance travels with every scheduled order, so automation never becomes a route around approval control. - Stickier customers. A buyer who runs replenishment through your storefront has embedded you in their production workflow, switching becomes a procurement project, not a price comparison. **Documentation:** - [Recurring Orders feature overview](https://docs.spryker.com/docs/pbc/all/order-experience-management/latest/base-shop/feature-overviews/recurring-orders-feature-overview) - [Install the Recurring Orders feature](https://docs.spryker.com/docs/pbc/all/order-experience-management/latest/base-shop/install-and-upgrade/install-features/install-the-recurring-orders-feature) - [Recurring Orders GA release](https://api.release.spryker.com/release-group/6689) ### Algolia API update {% include badge.html type="improvement" %} The Algolia integration has been updated to use the newer PHP client version. This change helps keep the integration aligned with the supported Algolia SDK lifecycle and reduces risk related to the older client reaching the end of SLA. **Key capabilities:** - Updates the integration to the newer Algolia PHP client version - Aligns the integration with Algolia's current supported SDK direction - Prepares customers for continued use without relying on an outdated client **Business benefits:** - Reduces support and lifecycle risk for customers using the Algolia integration - Improves confidence in long-term maintainability - Helps customers stay current with less ambiguity around SDK support status **Documentation:** - [Algolia module update](https://github.com/spryker-eco/algolia/releases/tag/2.0.0) - [Migration guide](https://docs.spryker.com/docs/pbc/all/search/latest/base-shop/third-party-integrations/algolia/upgrade-the-algolia-module) ### Vertex Back Office Configuration {% include badge.html type="feature" %} The Vertex configuration page in the Back Office has been updated to reflect the new integration and replace legacy App Composition Platform-oriented fields. This makes the setup clearer and better aligned with the current Vertex integration experience. **Key capabilities:** - Updates Vertex configuration fields in the Back Office - Replaces legacy field structure inherited from the previous ACP-based setup - Aligns configuration with the new integration model **Business benefits:** - Simplifies Vertex setup for business and implementation teams - Reduces confusion caused by outdated configuration fields - Helps shorten implementation and configuration time **Documentation:** - [Configure Vertex in the Back Office](https://docs.spryker.com/docs/pbc/all/tax-management/latest/base-shop/third-party-integrations/vertex/install-vertex/configure-vertex-in-the-back-office) ## Connected, and AI-Enabled Platform ### AI Dev SDK: Introduce Project Setup Wizard {% include badge.html type="feature,early-access" %} The AI Dev SDK now provides a guided setup wizard for new Spryker B2B Marketplace projects based on a fresh demoshop clone. It captures project decisions once and applies them through a resumable setup workflow. This helps teams move faster from initial clone to a verified, project-shaped shop.

**Key capabilities:** - Runs a guided setup interview covering project identity, services, stores, localization, CI, and run mode - Applies setup decisions through orchestrated steps with resume support if the process is interrupted - Produces setup artifacts, verification results, and a summary of remaining manual actions **Business benefits:** - Reduces time and effort needed to initialize a new project - Improves consistency across early project setup decisions - Gives teams a clearer and more reliable path to a ready-for-scope development environment **Documentation:** - [AI Dev SDK Project Starter Wizard](https://docs.spryker.com/docs/dg/dev/ai/ai-dev/ai-dev-project-starter-wizard) ### AI Dev SDK: Introduce Project Upgrade Helper {% include badge.html type="feature,early-access" %} The AI Dev SDK now includes an AI-assisted upgrade workflow for customized Spryker projects. It carries a project from its current release to the target one, adopting major module releases into existing project code and verifying the result against a running application. Team checkpoints keep release choice and feature adoption under explicit control. **Key capabilities:** - Moves a customized project onto the target Spryker release and resolves the dependency work automatically - Adopts major module releases into project code by applying the official migration guides to existing customizations - Realigns customizations, including customized storefront and Back Office screens, with the updated platform - Verifies the upgraded project against a running application, covering artifact regeneration, tests, and key pages - Keeps release choice and new feature adoption under team control at defined checkpoints - Records progress and findings so an upgrade can pause, resume, and run as repeatable CI checks **Business benefits:** - Turns weeks of manual upgrade investigation into a guided, largely automated run - Keeps existing customizations working instead of quietly going dead after an upgrade - Adopts new platform capabilities only when the team chooses them - Makes upgrades reviewable and resumable across sprints **Documentation:** - [AI Dev SDK Upgrade Workflow](https://docs.spryker.com/docs/dg/dev/ai/ai-dev/ai-dev-upgrade-workflow) ### AI Dev SDK: Autonomous Bugfixer & Improved Customization Workflow {% include badge.html type="early-access" %} {% include badge.html type="feature" %} The AI Dev SDK introduces a new guided workflow for turning bug reports into validated project changes and improves the existing workflow for feature requests. Teams can start with plain-language input and follow an orchestrated path through planning, implementation, verification, and review, while retaining decision-making throughout the workflow and reviewing and approving changes before they are delivered. **Key capabilities:** - Improves feature implementation from request intake through acceptance criteria, implementation planning, coding, and verification - Supports bug fixing from symptom or ticket intake through reproduction, root-cause analysis, minimal fix, testing, QA, and final verification - Produces traceable reports and supports collaborative or autonomous execution modes **Business benefits:** - Speeds up delivery from request or incident to validated change - Reduces manual handoffs across implementation, QA, and review steps - Improves consistency and traceability in AI-assisted development workflows **Documentation:** - [AI Dev SDK Bugfix Workflow](https://docs.spryker.com/docs/dg/dev/ai/ai-dev/ai-dev-bugfix-workflow) - [AI Dev SDK Customization Workflow](https://docs.spryker.com/docs/dg/dev/ai/ai-dev/ai-dev-customization-workflow) ### AI Commerce: Configurable Instructions Prompt {% include badge.html type="improvement,early-access" %} AI Commerce feature prompts can now be configured consistently through the Back Office across the platform, rather than being hardcoded in the codebase. This applies to capabilities such as Search by Image, Visual Add-to-Cart, the Back Office Assistant, and Smart PIM. Teams can customise prompts more easily to reflect project-specific language, tone, and business requirements, without requiring deployments or support from developer teams. **Key capabilities:** - Moves prompt definitions to configurable project-level settings with default values provided out of the box - Supports prompt customization without changing the codebase - Enables easier tuning of AI behavior for specific catalogs, industries, and branding needs **Business benefits:** - Makes AI Commerce features easier to adapt for different business contexts - Reduces custom code and upgrade friction in AI Commerce projects - Shortens iteration cycles for prompt tuning and testing **Documentation:** - [AI Commerce Overview](https://docs.spryker.com/docs/dg/dev/ai/ai-commerce/ai-commerce-overview) ## Efficient and Flexible Cloud Foundation ### Enhancements to Symfony Scheduler {% include badge.html type="improvement" %} We improved scheduled job management to give teams more control and better visibility in the Back Office and PaaS environment. You can now manage job execution more easily, run multiple schedules in parallel within the same container, and review richer operational logs and status information. {% include carousel.html images=" https://spryker.s3.eu-central-1.amazonaws.com/docs/About/Releases/release-notes-202608/scheduler2.png||:: https://spryker.s3.eu-central-1.amazonaws.com/docs/About/Releases/release-notes-202608/scheduler1.png||" %} **Key capabilities:** - Start, stop, enable, and disable scheduled jobs from the Back Office - Run multiple scheduled jobs in parallel in the same container to reduce infrastructure overhead - View job status details such as running, waiting, error state, worker name, timing, priority, and error logs of the last run **Business benefits:** - Reduces operational effort for managing scheduled jobs - Improves transparency for support and business teams through better job visibility - Helps optimize infrastructure usage and costs **Release:** - [Enhancements to Symfony Scheduler](https://api.release.spryker.com/release-group/6718) ### Maintenance and Service Updates {% include badge.html type="improvement" %} We delivered routine maintenance and service updates across the cloud foundation to keep environments secure, reliable, and aligned with current technology standards. These updates introduce PHP 8.5 as the default runtime version, add initial support for OpenSearch 2.x and 3.x, and establish the foundation for migrating from AWS OpenSearch 1.x. **Key capabilities:** - Added PHP 8.5 support to Docker SDK PHP images and enabled it as the default version. PHP 8.2 images are still available, while discontinuing further image generation for that version [after 2026](https://www.php.net/supported-versions.php) - Added compatibility for indexing, reading, and writing data with newer OpenSearch versions. - Support for the newer OpenSearch version in Spryker PaaS comes in the next release. **Business benefits:** - Improves security and stability through up-to-date platform components - Helps teams remain aligned with supported PHP and OpenSearch technology versions - Reduces operational risk and technical debt **Documentation:** - [Upgrade to PHP 8.5](https://docs.spryker.com/docs/dg/dev/upgrade-and-migrate/upgrade-to-php-85) - [Supported versions of PHP](https://docs.spryker.com/docs/dg/dev/supported-versions-of-php) - [OpenSearch migration to 3.5](https://docs.spryker.com/docs/pbc/all/search/latest/base-shop/install-and-upgrade/migrate-from-opensearch-1.3-to-3.5) ### Frontend builder for Yves moved into ShopUi {% include badge.html type="improvement" %} We moved the Yves builder into ShopUi and introduced a cleaner extension approach for project-level customization. This makes the builder more reusable, configurable, and easier to maintain across projects. **Key capabilities:** - Builder logic is now centralized in ShopUi instead of the project layer - Project teams can extend entry paths, discovery paths, and namespaces through configuration - Supports project-level overrides without changing module internals **Business benefits:** - Reduces customization effort for frontend builds - Improves maintainability and reuse across projects - Simplifies frontend setup while preserving existing storefront behavior **Documentation:** - [Frontend builder for Yves v2](/docs/dg/dev/frontend-development/latest/yves/frontend-builder-for-yves-v2) - [Upgrade to frontend builder v2 for Yves](/docs/dg/dev/upgrade-and-migrate/upgrade-to-frontend-builder-v2-for-yves) ### Dynamic multistore locale visibility fixes {% include badge.html type="improvement" %} We fixed an issue where adding a new locale via Dynamic Multistore could result in products, category trees, and navigation not being visible as expected. **Key capabilities:** - Correctly populates entities with data for newly added locales - Restores product visibility for newly added locales - Ensures category trees and navigation are displayed correctly after locale addition **Business benefits:** - Reduces setup issues when expanding into new locales - Helps teams launch localized storefronts with fewer manual corrections - Ensures consistent and complete entity data across stores and locales **Documentation:** - [Adjusted editing navigation for new locale](https://api.release.spryker.com/release-group/6658) ### Customer login consistency improvements {% include badge.html type="improvement" %} We fixed an issue that could break login behavior when a customer signed in from different places. **Key capabilities:** - Improves login handling across multiple customer sessions - Prevents disruptions caused by parallel or distributed login activity - Stabilizes customer authentication behavior **Business benefits:** - Reduces customer login friction - Improves reliability of the customer account experience - Lowers support effort related to authentication issues **Documentation:** - [Fixed session handler to avoid behavior inconsistency](https://api.release.spryker.com/release-group/6656) ### Reservation aggregation across multiple plugins {% include badge.html type="improvement" %} We introduced a new, more flexible plugin stack for reservation calculation. The new mechanism executes all configured reservation aggregation plugins, ensuring that reservation data is processed completely and accurately. **Key capabilities:** - Executes multiple reservation aggregation plugins in sequence - Prevents incomplete aggregation when reservations span multiple stores or warehouses - Avoids incorrect merging behavior during reservation processing - Provides a more flexible foundation for extending reservation calculation logic **Business benefits:** - Improves inventory and reservation accuracy - Supports more complex multi-store and warehouse setups - Reduces risk of stock inconsistencies **Documentation:** - [Install the Packaging Units feature](https://docs.spryker.com/docs/pbc/all/product-information-management/latest/base-shop/install-and-upgrade/install-features/install-the-packaging-units-feature#set-up-behavior) - [Install the Marketplace Inventory Management + Order Management feature](https://docs.spryker.com/docs/pbc/all/warehouse-management-system/latest/marketplace/install-features/install-the-marketplace-inventory-management-order-management-feature#prerequisites) - [Install the Marketplace Inventory Management + Packaging Units feature](https://docs.spryker.com/docs/pbc/all/warehouse-management-system/latest/marketplace/install-features/install-the-marketplace-inventory-management-packaging-units-feature#set-up-behavior) - [Multistore reservation aggregation](https://api.release.spryker.com/release-group/6611) - [Fix reservation aggregation request expander](https://api.release.spryker.com/release-group/6676) ### API Platform nested object schema support {% include badge.html type="improvement" %} We extended API Platform resource YAML so a list of objects can declare its element shape. A `type: array` property with a sibling items block now publishes the element as a referenced component schema, instead of a bare untyped array. Single nested objects were already typed; this closes the gap for collections. Key capabilities: - Declare `items: {type: object, properties: …}` alongside `type: array` in a resource schema - The generated OpenAPI document references a generated element schema and registers it in the same document - Lists of scalars and canonical (shared) object shapes are supported - Existing providers keep working — assigning raw arrays is still valid; no provider rewrite required Adoption is per field, and opt-in for a reason: a typed element is a closed shape. Adding items to a list that is already part of a released response silently drops every payload key you did not declare. Before adopting an existing field, diff a real response payload against your intended items.properties. New fields are unaffected. Storefront APIs are unchanged. Note: openapiContext.items is documentation passthrough only — it generates nothing. Only a sibling of type: array produces a typed element schema. Documentation: - [Typed collections in the published contract](/docs/integrations/spryker-api/api-platform/typed-collections.html) - [Object collections](/docs/integrations/spryker-api/api-platform/resource-schemas.html#object-collections) ### Graceful handling of email delivery failures {% include badge.html type="improvement" %} We improved email sending mechanisms across Storefront, Back Office, Merchant Portal, and API to handle delivery failures gracefully without causing system errors or disrupting application workflows. **Key capabilities:** - Prevents email delivery failures from interrupting or causing the failure of primary business processes, including cases where email addresses or domains are not whitelisted in AWS SES sandbox mode. - Displays clear, non-disruptive error messages with error codes in the Storefront, Merchant Portal, and Back Office, while allowing the primary user action to complete successfully. - Records comprehensive details for every email delivery failure, including the email type, sender, recipients, and relevant exception details. - Logs email delivery failures that occur during Order Management System (OMS) processing without halting execution or leaving orders stuck. - Standardizes REST/Glue API responses to return a 422 Unprocessable Entity status code instead of a 500 Internal Server Error **Business benefits:** - Delivers a smooth user experience by preventing app crashes during email failure scenarios - Reduces support overhead and troubleshooting effort for technical and operations teams **Documentation:** - [Email service](/docs/ca/dev/email-service/email-service) - [Email deliverability](/docs/ca/dev/email-service/email-deliverability) ### Community contributions {% include badge.html type="improvement" %} We included several community-driven improvements in this release. These contributions help improve compatibility and code quality in commonly used modules. **Key capabilities:** - Made QuoteApproval compatible with PropelBehavior - Replaced docblocks with typed class constants in Transfer - Added support for sensitive properties in Transfer **Business benefits:** - Brings practical enhancements contributed by the community - Improves maintainability, security, and compatibility in key modules - Strengthens collaboration across the Spryker ecosystem **Documentation:** - [New community PR: Make QuoteApproval compatible to PropelBehavior](https://api.release.spryker.com/release-group/6664) - [New community PR: Add support of sensitive properties](https://api.release.spryker.com/release-group/6657)

Packaged Business Capabilities

Tue, 01 Sep 2026 08:26:04 +0000

Packaged Business Capabilities (PBCs) are capabilities that enclose a certain functionality with the Spryker system. PBCs provide a good foundation for decision makers throughout multiple business entities. This section is in beta because not all the PBCs are covered. Marketplace functionalities will also be added at a later stage. You are welcome to use the docs that are already here, and we will keep adding the docs for the rest of the PBCs. ## Spryker PBCs | NAME | DESCRIPTION | BENEFITS | | --- | --- | --- | | [AI Foundation](/docs/pbc/all/ai-foundation/{{site.version}}/ai-foundation.html) | Provider agnostic AI layer that connects Spryker Commerce OS to leading AI providers through one common interface. | Accelerates delivery of AI features and keeps freedom to choose and change AI providers and models per use case. | | [AI Commerce](/docs/pbc/all/ai-commerce/{{site.version}}/ai-commerce.html) | Brings AI assisted capabilities to the Spryker storefront and the Back Office to help buyers and operators complete commerce tasks faster and more consistently, reducing manual effort with human review and enterprise governance. | Speeds up key commerce workflows while improving consistency and reducing errors, enabling scalable adoption of assisted capabilities across teams and markets. | | [Business Intelligence](/docs/pbc/all/business-intelligence/{{site.version}}/business-intelligence.html) | Analyze data to understand how your shop performs and areas for improvement. | Make informed decisions. | | [Carrier Management](/docs/pbc/all/carrier-management/{{site.version}}/carrier-management.html) | The Spryker Cloud Commerce OS integrates with several shipping carriers and methods and lets you define their availability, price, and tax set. During the checkout process, customers have the option to select their preferred shipment method and relevant carrier. | Ensures quick and cost-effective delivery. | | [Cart and Checkout](/docs/pbc/all/cart-and-checkout/{{site.version}}/cart-and-checkout.html) | The online shopping cart and checkout process act as a gateway for customer and order management. It lets your customers organize and manage their purchases, apply vouchers and coupon codes. Based on their roles and permissions, your B2B customers can add or remove products, share the cart, and manage their purchases. | Increases conversion rates and reduces drop-off rates. Offers additional B2B specific, permission-related functionalities. | | [Content Management System (CMS)](/docs/pbc/all/content-management-system/{{site.version}}/content-management-system.html) | The CMS features let you customize your store, enrich it with information, stories, or other content, and make it easily findable in search engines. Several SEO features enable you to add customized meta information to all your content and create search engine-friendly URLs. | Provides compelling content and stories where your customers need it. | | [Customer Relationship Management (CRM)](/docs/pbc/all/customer-relationship-management/{{site.version}}/customer-relationship-management.html) | The customer management tool lets B2B and B2C businesses manage customer accounts and efficiently monitor shopping habits. It provides your B2B Customers with a way to map their business hierarchies, permissions, and role management. With the creation of distinctive Business Units, the internal hierarchy can easily be mapped out, and each Unit can operate independently. The Roles and Permissions System lets your customer's buyers define the purchase and approval process. | Increases conversion rates and average order values with a compact Customer Relationship Management tool. | | [Data Exchange](/docs/pbc/all/data-exchange/{{site.version}}/data-exchange.html) | You can import your business logic and data, including product information, customer base, categories, and more, into the Spryker Cloud Commerce OS. You can use the out-of-the-box export data functionality as a generic blueprint for any data set that you need to export. | Lets you import and export specific data points quickly and easily. | | [Discount Management](/docs/pbc/all/discount-management/{{site.version}}/discount-management.html) | You can define several types of discounts based on a brand, the overall cart value, specific product ranges, or unique customer groups. You can also offer discount vouchers or incentivize certain products through coupon codes. | Lets you run effective promotional campaigns to boost conversion rates. | | [Dynamic Multistore](/docs/pbc/all/dynamic-multistore/{{site.version}}/dynamic-multistore.html) | Manage stores in the Back Office | Make changes to your stores setup quickly and easily. | | [Emails](/docs/pbc/all/emails/{{site.version}}/emails.html) | You can send automated account e-mails and confirmations or offer different types of newsletter subscriptions. | Keep in touch with your customers. | | [Gift Cards](/docs/pbc/all/gift-cards/{{site.version}}/gift-cards.html) | Lets your customers purchase and redeem gift cards. Enabling gift card purchases can boost your brand awareness and help you reach new customers. | Lets you acquire new customers through gift card payment options. | | [Identity Access Management (IAM)](/docs/pbc/all/identity-access-management/{{site.version}}/identity-access-management.html) | Enables the creation of new accounts for end customers and B2B customers. It also allows users to define password settings and utilize multi-login blockers for security purposes. Moreover, a third-party access management function is integrated. | Allows for quick and easy authorization and authentication of customers | | [Merchant Management](/docs/pbc/all/merchant-management/{{site.version}}/merchant-management.html) | For efficient Merchant Management, two parts are important. One, the overview and management on the Operator side, like approvals, edits, etc. And two, the self-service management of the Merchants, where they can take care of their daily business, like order or product management. | Gives you an overview of all your Merchants' activities. | | Miscellaneous | This category holds the documents that are not related to any PBC. | | | [Offer Management](/docs/pbc/all/offer-management/{{site.version}}/offer-management.html) | Lets your Merchants create Offers on existing products in your Marketplace. By doing so, duplicates in the product catalog can be avoided and the management of Merchants, Products, and Offers becomes much more convenient. | Saves time because of a good overview of Merchant's Offers. | | [Order Management System (OMS)](/docs/pbc/all/order-management-system/{{site.version}}/order-management-system.html) | Helps you keep track of your order processing from your B2B, B2C, or Marketplace, and ensure quick fulfillment. You can manage incoming orders in the Back Office, view and edit orders, track their progress, or contact customers who make open orders directly. With the compact Order Management features, you can keep your order processing running smoothly. | Lets you pProcess orders smoothly to fulfill them quickly. | | [Payment Service Provider (PSP)](/docs/pbc/all/payment-service-provider/{{site.version}}/payment-service-provider.html) | Provides integration of payment methods. You can integrate multiple payment gateways, define their availability, and customize how they appear on your site. | Lets you provide an excellent shopping experience and integrate your customers' preferred payment methods. | | [Price Management](/docs/pbc/all/price-management/{{site.version}}/price-management.html) | The Spryker Cloud Commerce OS supports multiple currencies and automatically detects the payment currency based on a customer's preference. You can manage gross and net prices per product and per country. You can also offer volume discounts to encourage customers to purchase products in larger quantities. | Saves you time by letting you implement your pricing strategy in one place and catering it to your business needs. | | [Product Information Management (PIM)](/docs/pbc/all/product-information-management/{{site.version}}/product-information-management.html) | Encompasses all functionality that is needed to set up your product catalog. With PIM, you can create and extend the product catalog to match your business needs. | Helps you expand your business by organizing your products in a fast and efficient way. | | [Product Relationship Management](/docs/pbc/all/product-relationship-management/{{site.version}}/product-relationship-management.html) | Helps you enhance your shop with cross- and up-selling capabilities to increase sales. | Increases average order values with product relations. | | [Ratings and Reviews](/docs/pbc/all/ratings-reviews/{{site.version}}/ratings-and-reviews.html) | Lets you incorporate user reviews and ratings. You can receive and moderate feedback in the Back Office. The Ratings and Reviews feature also comes with the functionality to add text-free reviews and star ratings. | Inspires trust among customers with ratings and reviews. | | [Request for Quote (RFQ)](/docs/pbc/all/request-for-quote/{{site.version}}/request-for-quote.html) | Your customers can request a quote for products and services that you sell. The Request for Quote feature supports all functionalities of the price engine and product capabilities, such as Volume Prices, Customer Specific Prices, Measuring and Packaging units, Shipping costs, Product Options, etc. | Enhances customer loyalty and increase conversion rates. | | [Return Management](/docs/pbc/all/return-management/{{site.version}}/marketplace/marketplace-return-management-feature-overview.html) | Lets you establish a return policy and execute returns. | Increase customer satisfaction and loyalty. | | [Search](/docs/pbc/all/search/{{site.version}}/base-shop/search-feature-overview/search-feature-overview.html) | The out-of-the-box Elasticsearch technology lets you include full-text search, auto-suggestions, and auto-completion. You can set individual search preferences for multiple stores and categorize your products by adding dynamic filters and facets to help your customers further refine the search results. You can also add more advanced filters that use the product's metadata or promote a brand's top-sellers or highly rated products. | Helps you increase conversion rates by providing an excellent Search and Filter experience. | | [Service Points Management](/docs/pbc/all/service-point-management/{{site.version}}/service-point-management.html) | Set up offline service points where customers can interact with your business. | Creates touch points to connect a shop with offline locations. | | [Shopping List and Wishlist](/docs/pbc/all/shopping-list-and-wishlist/{{site.version}}/shopping-list-and-wishlist.html) | Your B2B customers can save the products they wish to purchase, in shopping lists. Different roles and permission systems ensure smooth sharing and contribution management amongst company users. This PBC encompasses additional features like printing, barcode generation, and direct-to-cart. Enabling your B2C customers to track and save the products they wish to purchase through a wish list function effectively reduces cart abandonment, boosts your sales, and allows you to keep track of which products are of interest to your customers. | Lets you increase conversion rates and loyalty by offering rich Shopping and B2B Wish Lists. | | [Tax Management](/docs/pbc/all/tax-management/{{site.version}}/tax-management.html) | Lets you adhere to respective tax regulations in the countries you sell by configuring and managing tax rates for products, shipments, and additional services. You can define tax rates for different countries and apply integrations to manage US taxes. | Lets you comply with fiscal regulations. | | [User Management](/docs/pbc/all/user-management/{{site.version}}/user-management.html) | Lets the Back Office users manage user access, set rights, and onboard customers. | Ensures high security and compliance through managed user flows. | | [Warehouse Management System (WMS)](/docs/pbc/all/warehouse-management-system/{{site.version}}/warehouse-management-system.html) | Lets you keep an overview of your stock levels in the Back Office to determine accurate availabilities on your store's website. Any open orders or reserved items are taken into consideration when stock availabilities are displayed. | Helps you save your time by keeping an eye on your stock levels. | | [Workflows](/docs/pbc/all/back-office/latest/base-shop/workflows-feature-overview.html) | Workflows lets operations teams design, run, and improve multi-step processes for different entities directly in the Back Office, without relying on developers for every change. Teams can manage process definitions and their versions, so they can work on process improvements without disrupting processes that are currently running. | Speeds up process changes and reduces developer dependency by letting business teams design and adjust workflows directly in the Back Office. | ### Application PBCs | NAME | DESCRIPTION | BENEFITS | | --- | --- | --- | | Back Office | The administration interface that allows you to manage all back-office tasks. In the Back Office, you can manage and create customer accounts and define who can access the Back Office. You can also keep track of all your internal processes including the management of your products, orders, customers and many more. | Keeps your back-end processes running efficiently, protects your data and administers all accounts. | | Storefront | The out-of-the-box online shop application that includes all regular functionalities and workflows. You can use the Storefront as a boilerplate to kick-start your project. | Lets you easily start your online shop from our boilerplate solution. | ## App Composition Platform apps

| APP | CATEGORY | | --- | --- | | [Vertex](/docs/pbc/all/tax-management/{{site.version}}/base-shop/third-party-integrations/vertex/vertex.html) | Tax compliance. | | [Algolia](/docs/pbc/all/search/{{site.version}}/base-shop/third-party-integrations/algolia/integrate-algolia.html) | Search engine. | | [Payone](/docs/pbc/all/payment-service-providers/payone/integrate-payone.html) | Payment service provider. | | [Bazaarvoice](/docs/pbc/all/ratings-reviews/{{site.version}}/third-party-integrations/integrate-bazaarvoice.html) | Platform for user-generated content. | | [Stripe](/docs/pbc/all/payment-service-provider/{{site.version}}/base-shop/third-party-integrations/stripe/stripe.html) | Financial infrastructure platform. |

View service points

Mon, 31 Aug 2026 13:10:15 +0000

This topic describes how to view [service points](/docs/pbc/all/service-point-management/latest/unified-commerce/service-points-feature-overview.html#service-point) in the Back Office. To start working with service points, go to **Customer Portal > Service Points**. The Back Office presents service points as read-only information. To create or change them, use the [Glue API](/docs/pbc/all/service-point-management/latest/unified-commerce/manage-using-glue-api/manage-service-points/glue-api-add-service-points.html) or [data import](/docs/pbc/all/service-point-management/latest/unified-commerce/import-and-export-data/import-file-details-service-point.csv.html). ## Prerequisites Import service points, or add them using Glue API. Both active and inactive service points are displayed. Each section contains reference information. Review it before you start, or look up the necessary information as you go through the process. ## View the list of service points To view all the service points of your project: 1. Go to **Customer Portal > Service Points**. This opens the **Service Points** page. 2. Optional: To find a specific service point, enter its name, key, city, zip code, or country in **Search**. 3. Optional: To change the order of the records, click a column header. ![Service points list in the Back Office](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/service-point-management/unified-commerce/manage-in-the-back-office/service-points-list.png) **Tips and tricks**
Inactive service points remain in the list and are marked as **Inactive**. A service point that has no address yet is displayed with **Not set** in the **Address** column. ### Reference information: View the list of service points The following table describes the columns of the **Service Points** page: | COLUMN | DESCRIPTION | | --- | --- | | Name | Name of the service point. | | Key | Unique service point identifier. | | Address | Zip code, city, and country of the service point. Displays **Not set** if the service point has no address. | | Stores | All the stores the service point is assigned to. | | Service Types | Service types of all the services provided at the service point. | | Status | Defines if the service point is active. Inactive service points are not offered on the Storefront. | | Actions | Opens the details of the service point. | ## View the details of a service point To view the details of a service point: 1. Go to **Customer Portal > Service Points**. 2. Next to the service point you want to view, click **View**. This opens the **View Service Point** page. ![Service point details in the Back Office](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/service-point-management/unified-commerce/manage-in-the-back-office/service-point-details.png) ### Reference information: View the details of a service point The following table describes the sections of the **View Service Point** page: | SECTION | DESCRIPTION | | --- | --- | | Service Point | Name, key, status, and assigned stores of the service point. | | Address | Full address of the service point in one line: street, zip code, city, region, and country. Parts that are not defined are omitted. Displays **Not set** if the service point has no address. | | Services | All the services provided at the service point, with their service type, key, and status. | | Connected Offers | All the product offers that are provided through the services of the service point. An offer connected through several services of the same service point is displayed once. | The following table describes the columns of the **Connected Offers** section: | COLUMN | DESCRIPTION | | --- | --- | | Offer Reference | Unique product offer identifier. | | SKU | SKU of the concrete product the offer belongs to. | | Stores | All the stores the product offer is assigned to. | | Approval Status | Approval status of the product offer: **Approved**, **Waiting for Approval**, or **Denied**. | | Status | Defines if the product offer is active. | | Actions | Opens or edits the product offer. The actions are displayed only if the corresponding pages are configured in your project. |

Service Points feature overview

Mon, 31 Aug 2026 13:10:15 +0000

The *Service Points* feature lets you create and manage service points, service types, and associated services. ## Service point A *service point* is a physical location where services are provided. Depending on the services provided, there can be different kinds of service points, like a warehouse or a physical store. The definition of a service point ultimately depends on the services it provides. To add service points using Glue API, see [Add service points](/docs/pbc/all/service-point-management/latest/unified-commerce/manage-using-glue-api/manage-service-points/glue-api-add-service-points.html). To import service points, see [Import file details: service_point.csv](/docs/pbc/all/service-point-management/latest/unified-commerce/import-and-export-data/import-file-details-service-point.csv.html). To add service point addresses using Glue API, see [Add service point addresses](/docs/pbc/all/service-point-management/latest/unified-commerce/manage-using-glue-api/manage-service-point-addresses/glue-api-add-service-point-addresses.html). To import service point addresses, see [Import file details: service_point_address.csv](/docs/pbc/all/service-point-management/latest/unified-commerce/import-and-export-data/import-file-details-service-point-address.csv.html) ## Service type A *service type* is a classification of services that a business offers to its customers. Service types are determined by the nature of the business. Service type examples: - Pickup service - Return service - Rental service - Repair service To add service types using Glue API, see [Add service types](/docs/pbc/all/service-point-management/latest/unified-commerce/manage-using-glue-api/manage-service-types/glue-api-add-service-types.html). To import service types, see [Import file details: service_type.csv](/docs/pbc/all/service-point-management/latest/unified-commerce/import-and-export-data/import-file-details-service-type.csv.html). ## Service A *service* represents a specific service type that is provided at a specific service point. Because each service is unique, if two service points provide services with the same service type, like pickup, those services are represented as two separate entities and are managed accordingly. For example, a pickup service at a retail location at Julie-Wolfthorn-Straße 1, 10115, Berlin is a unique service. To add services using Glue API, see [Add services](/docs/pbc/all/service-point-management/latest/unified-commerce/manage-using-glue-api/manage-services/glue-api-add-services.html). To import services, see [Import file details: service.csv](/docs/pbc/all/service-point-management/latest/unified-commerce/import-and-export-data/import-file-details-service.csv.html). ## Service points use cases With the help of service points, types, and services, a store operator can model different use cases depending on their business needs. Here are some examples of services that can be implemented at the project level: - Ship from store - Car maintenance or installations services - Product demonstration at a retail location - Repair service at a retail location ## Service points in the Back Office Back Office users can review all the service points of a project, including the inactive ones, in **Customer Portal > Service Points**. The list shows the name, key, address, assigned stores, service types, and status of every service point. Opening a service point displays its address, the services provided at it, and the product offers connected to it through those services. Service points are read-only in the Back Office. To create or change them, use Glue API or data import. For more details, see [View service points](/docs/pbc/all/service-point-management/latest/unified-commerce/manage-in-the-back-office/view-service-points.html). ## Service points on the Storefront When checking out, customers select a service point they want the order to be processes at. The feature is shipped with a search widget that lets them search service points by the following: - Service point name - Zip code - City By default, search results are sorted by city. ![service point search widget](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/service-point-management/unified-commerce/service-points-feature-overview.md/service-point-search.png) You can add only predefined service points by default. But developers can configure customers to be able to enter custom addresses for service points. After placing an order, the customer can see the selected service point on the Order Details page. ![Storefront order with a service point](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/service-point-management/unified-commerce/service-points-feature-overview.md/storefront-order-service-point.png) ## Current constraints - Services can be configured only for product offers. - Product catalog can't be filtered by a service type or a service provided in a specific service point. - The product offer widget on the product details page is not supported. It doesn't show the differences between product offers based on the services assigned to them. As a result, differnt product offers are displayed as duplicates. - Customers can't add products with preselected service points to cart. They can select service points only during checkout. - If a product is added to cart without a product offer attached to it, this product can be purchased only with the *Delivery* shipment type. ## Related Business User documents | FEATURE OVERVIEWS | MERCHANT PORTAL GUIDES | | - | - | | [Shipment feature overview](/docs/pbc/all/carrier-management/latest/base-shop/shipment-feature-overview.html) | [Create and edit product offers](/docs/pbc/all/offer-management/latest/unified-commerce/unified-commerce-create-and-edit-product-offers.html) | ## Related Developer documents | INSTALLATION GUIDES | GLUE API GUIDES | | - | - | | [Install the Service Points feature](/docs/pbc/all/service-point-management/latest/unified-commerce/install-features/install-the-service-points-feature.html) | [Add service points](/docs/pbc/all/service-point-management/latest/unified-commerce/manage-using-glue-api/manage-service-points/glue-api-add-service-points.html) | | [Install the Service Points + Shipment feature](/docs/pbc/all/service-point-management/latest/unified-commerce/install-features/install-the-service-points-shipment-feature.html) | [Retrieve service points](/docs/pbc/all/service-point-management/latest/unified-commerce/manage-using-glue-api/manage-service-points/glue-api-retrieve-service-points.html) | | [Install the Service Points + Customer Account Management feature](/docs/pbc/all/service-point-management/latest/unified-commerce/install-features/install-the-service-points-customer-account-management-feature.html) | [Update service points](/docs/pbc/all/service-point-management/latest/unified-commerce/manage-using-glue-api/manage-service-points/glue-api-update-service-points.html) | | [Install the Service Points + Order Management feature](/docs/pbc/all/service-point-management/latest/unified-commerce/install-features/install-the-service-points-order-management-feature.html) | [Add service types](/docs/pbc/all/service-point-management/latest/unified-commerce/manage-using-glue-api/manage-service-types/glue-api-add-service-types.html) | | [Install the Product Offer Shipment feature](/docs/pbc/all/offer-management/latest/marketplace/install-and-upgrade/install-features/install-the-product-offer-shipment-feature.html) | [Retrieve service types](/docs/pbc/all/service-point-management/latest/unified-commerce/manage-using-glue-api/manage-service-types/glue-api-retrieve-service-types.html) | | [Install the Shipment + Customer Account Management feature](/docs/pbc/all/carrier-management/latest/base-shop/install-and-upgrade/install-features/install-the-shipment-customer-account-management-feature.html) | [Update service types](/docs/pbc/all/service-point-management/latest/unified-commerce/manage-using-glue-api/manage-service-types/glue-api-update-service-types.html) | | | [Add service point addresses](/docs/pbc/all/service-point-management/latest/unified-commerce/manage-using-glue-api/manage-service-point-addresses/glue-api-add-service-point-addresses.html) | | | [Retrieve service point addresses](/docs/pbc/all/service-point-management/latest/unified-commerce/manage-using-glue-api/manage-service-point-addresses/glue-api-retrieve-service-point-addresses.html) | | | [Add service point addresses](/docs/pbc/all/service-point-management/latest/unified-commerce/manage-using-glue-api/manage-service-point-addresses/glue-api-update-service-point-addresses.html) | | | [Add services](/docs/pbc/all/service-point-management/latest/unified-commerce/manage-using-glue-api/manage-services/glue-api-add-services.html) | | | [Retrieve services](/docs/pbc/all/service-point-management/latest/unified-commerce/manage-using-glue-api/manage-services/glue-api-retrieve-services.html) | | | [Update services](/docs/pbc/all/service-point-management/latest/unified-commerce/manage-using-glue-api/manage-services/glue-api-update-services.html) |

System requirements

Mon, 31 Aug 2026 06:49:34 +0000

## System requirements (apps based on Spryker Framework) | REQUIREMENT | VALUE | |--------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | OS | Native: Linux | | Web server | NginX or any web server supporting PHP, like lighttpd, Apache, or Cherokee. | | Databases | For cloud environments, MariaDB >= 11.8 preferred. For on-premise environments, PostgreSQL >=17 or MySQL >=8.4. | | PHP | PHP >=8.3 with the following extensions: `curl`, `json`, `mysql`, `pdo-sqlite`, `sqlite3`, `gd`, `intl`, `mysqli`, `pgsql`, `ssh2`, `gmp`, `mcrypt`, `pdo-mysql`, `readline`, `twig`, `imagick`, `memcache`, `pdo-pgsql`, `redis`, `xml`, `bz2`, and `mbstring`. For details about supported PHP versions, see [Supported Versions of PHP](/docs/dg/dev/supported-versions-of-php.html) | | SSL | For production environments, a valid security certificate is required for HTTPS. | | Key-value store (Redis or Valkey) | Redis versions 5.0 and 6.2; Valkey version >=7.2 | | Search engines | Elasticsearch 7.x, OpenSearch [1.3, 2.19, 3.5](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/what-is.html#end-of-support) | | RabbitMQ | Version >=4.1 | | Jenkins (for cronjob management) | Version >=2.0 | | Graphviz (for state machine visualization) | Version >=2.0 | | Node.js | Version >= 24.14.0. For details about upgrading, see [Upgrade Node.js and npm](/docs/dg/dev/upgrade-and-migrate/upgrade-nodejs.html) | | npm | Version >= 10.0.0 | | Intranet | Back Office application must be secured in an Intranet using VPN, Basic Auth, IP allowlist, or DMZ. | | Available languages | German and English. UTF-8 left-to-right languages are fully supported. | ## Marketplace system requirements | OPERATING SYSTEM | NATIVE: LINUX-ONLY THROUGH VM: MACOS AND MS WINDOWS | |---|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Web server | NginX or any web server supporting PHP, like lighttpd, Apache, or Cherokee. | | Databases | MariaDB >= 11.8 preferred, PostgreSQL >=17, or MySQL >=8.4. | | PHP | PHP >=8.3 with the following extensions: `curl`, `json`, `mysql`, `pdo-sqlite`, `sqlite3`, `gd`, `intl`, `mysqli`, `pgsql`, `ssh2`, `gmp`, `mcrypt`, `pdo-mysql`, `readline`, `twig`, `imagick`, `memcache`, `pdo-pgsql`, `redis`, `xml`, `bz2`, `mbstring`. For details about supported PHP versions, see [Supported Versions of PHP](/docs/dg/dev/supported-versions-of-php.html). | | SSL | For production systems, a valid security certificate is required for HTTPS. | | Key-value store (Redis or Valkey) | Redis versions 5.0 and 6.2; Valkey version >=7.2 | | Search engines | Elasticsearch >=7.0, OpenSearch >=1.3 | | RabbitMQ | Version >=4.1 | | Jenkins (for cronjob management) | Version >=2.0 | | Graphviz (for state machine visualization) | Version >=2.0 | | Symfony | Versions 5.0, and 6.0 | | Node.js | Version >= 24.14.0. For details about upgrading, see [Upgrade Node.js and npm](/docs/dg/dev/upgrade-and-migrate/upgrade-nodejs.html) | | npm | Version >= 10.0.0 | | Intranet | Back Office application must be secured in an Intranet using VPN, Basic Auth, IP allowlist, or DMZ. | | Spryker Commerce OS | Version >= {{page.release_tag}} |

Migrate from OpenSearch 1.3 to 3.5

Wed, 26 Aug 2026 12:12:26 +0000

This document describes how to migrate an OpenSearch cluster used by a Spryker project from version 1.3 to 3.5. Between major OpenSearch versions, an index or a cluster setting can become incompatible with the target version, for example because of an outdated Lucene index format, a deprecated setting, or a breaking plugin change. OpenSearch does not support skipping major versions and cannot be upgraded in place while such incompatibilities exist, so the upgrade is blocked until you resolve them. To resolve this, you upgrade the cluster incrementally, from 1.3 to 2.19, and then from 2.19 to 3.5, fixing every incompatibility before each upgrade. {% info_block warningBox "Verification" %} Before you start, test the migration in a non-production environment. Blocking writes to an index makes it read-only until the reindexing is complete, so plan the migration for a maintenance window. {% endinfo_block %} ## 1. Update the required modules You only need to update the packages for the features used in your project. Check the following table and update the packages that are installed in your project to at least the specified versions: | Package | Minimum version | | --- | --- | | `spryker/sales-return-search` | 1.4.1 | | `spryker/merchant-search` | 1.3.1 | | `spryker/product-review` | 2.15.1 | | `spryker/search-elasticsearch` | 1.23.1 | | `spryker/service-point-search` | 1.4.1 | | `spryker-feature/self-service-portal` | 20.9.1 | Update the packages installed in your project using Composer: ```bash composer update spryker/merchant-search:"^1.3.1" spryker/product-review:"^2.15.1" spryker/sales-return-search:"^1.4.1" spryker/search-elasticsearch:"^1.23.1" spryker/service-point-search:"^1.4.1" spryker-feature/self-service-portal:"^20.9.1" ``` If your project overrides the search schema of these modules, apply the equivalent changes to your project-level search schema as well. ## 2. Check the upgrade eligibility Consult the breaking changes and deprecation notices for OpenSearch 2.19, and check your indexes and cluster settings against them to determine whether the cluster is eligible for the upgrade. - If the cluster is eligible, upgrade it to 2.19 and continue to [4. Check the upgrade eligibility for 3.5](#4-check-the-upgrade-eligibility-for-35). - If the cluster is not eligible, one or more incompatibilities block the upgrade. - For an index with an incompatible index format, unblock the upgrade by reindexing it as described in the following section. - For any other incompatibility, for example a deprecated index setting or a breaking plugin change, fix it first. Only continue with the upgrade after all the incompatibilities are resolved. ## 3. Reindex an index to unblock the upgrade Repeat the following steps for every index with an incompatible index format. Replace `` with the name of the index you are migrating. ### 3.1. Block writes to the index To prevent data from changing while the index is being cloned, block write operations: ```json PUT //_settings { "settings": { "index.blocks.write": true } } ``` ### 3.2. Clone the index Clone the index into a temporary index: ```json PUT //_clone/_tmp ``` ### 3.3. Verify the document count Compare the document count of `` and `_tmp`. The counts must match before you continue. ### 3.4. Delete the original index ```json DELETE / ``` ### 3.5. Re-create the index and its schema Re-create the index and install its schema using the following console command: ```bash console search:setup:sources ``` ### 3.6. Reindex the documents Reindex the documents from the temporary index back into the newly created ``: ```json POST /_reindex?slices=2&wait_for_completion=false { "source": { "index": "_tmp" }, "dest": { "index": "" } } ``` ### 3.7. Verify the document count again Compare the document count of `` and `_tmp` again. The counts must match before you continue. ### 3.8. Delete the temporary index ```json DELETE /_tmp ``` After you reindex all the blocking indexes, upgrade the cluster to version 2.19. ## 4. Check the upgrade eligibility for 3.5 Consult the breaking changes and deprecation notices for OpenSearch 3.5, and check your indexes and cluster settings on version 2.19 against them to determine whether the cluster is eligible for the upgrade. - If the cluster is eligible, upgrade it to 3.5. - If the cluster is not eligible, incompatibilities again block the upgrade. Resolve them the same way as in step 2: reindex every index with an incompatible index format by repeating the steps in [3. Reindex an index to unblock the upgrade](#3-reindex-an-index-to-unblock-the-upgrade), and fix any other incompatibility. Then upgrade the cluster to 3.5.

Upgrade the PurchasingControl module

Tue, 25 Aug 2026 08:40:54 +0000

{% include pbc/all/upgrade-modules/upgrade-the-purchasingcontrol-module.md %}

Purchasing Control feature overview

Tue, 25 Aug 2026 08:40:54 +0000

The *Purchasing Control* feature lets B2B companies track and control procurement spending by assigning orders to cost centers and enforcing configurable budget rules. It extends the existing [Approval Process](/docs/pbc/all/cart-and-checkout/latest/base-shop/feature-overviews/approval-process-feature-overview.html) with a second dimension of spending governance: per-department or per-project budget limits that work alongside the existing per-person permission limits. Buyers assign a cost center and a budget to a cart at checkout or to a quote request, and agents can do the same on a customer's behalf. {% info_block infoBox "Info" %} This feature is available in the Back Office and on the Storefront. {% endinfo_block %} ## Cost centers A *cost center* is an organizational unit within a company that incurs costs but does not directly generate revenue. Companies use cost centers to track and control spending by department, project, location, or function. **Common examples:** - **Departmental:** Marketing, Engineering, HR, Facilities - **Project-based:** Office Renovation Q2 2026, Trade Show Berlin - **Location-based:** Warehouse Berlin, Office London Every purchase a buyer makes is charged to a cost center so the company can track where money is being spent. In ERP systems such as SAP, Oracle, and Microsoft Dynamics, cost centers are a foundational accounting concept - orders flow into the ERP tagged with a cost center code, enabling financial reporting and cost allocation. ### Deactivated cost centers and budgets A cost center or budget can be deactivated instead of deleted, which preserves the history of the orders already charged to it. Deactivated records are not offered in the cost center and budget selectors, and a deactivated cost center is no longer shown where the assignment of a cart or quote is displayed. If every cost center available to a buyer is deactivated, or if the selected cost center has no active budget left, no choices are rendered and the buyer cannot assign one until an active record is available again. ## Budgets A *budget* is a spending limit assigned to a cost center for a defined period - monthly, quarterly, or annually. It represents the maximum amount that a department or project is authorized to spend in that period. **Example:** The Marketing department has a quarterly procurement budget of €50,000 for office supplies and event materials. Once that budget is consumed, further purchases are either blocked, flagged for review, or escalated for approval. ### Budget enforcement rules Each budget is configured with one of three enforcement rules: | RULE | DESCRIPTION | | --- | --- | | Block | The order is rejected outright when the budget is exceeded. The buyer cannot proceed to checkout. | | Warn | A warning is displayed to the buyer, but they can proceed. | | Require Approval | The order is sent for approval when the budget is exceeded. The buyer cannot complete checkout until an approver accepts the order. | ### Budgets in recurring orders With the [Recurring Orders feature](/docs/pbc/all/order-experience-management/latest/base-shop/feature-overviews/recurring-orders-feature-overview.html) installed, a recurring order carries a cost center and a budget, selected on the recurring order forms and changeable when the buyer edits the schedule or approves a review. Budgets with the **Require Approval** enforcement rule cannot be used for a recurring order. A recurring order places its follow-up orders unattended, so no approver can accept them at placement time. The restriction applies in two places: - Such budgets are not offered in the recurring order budget selector. - Checkout is blocked if a quote being set up as a recurring order carries one. This check applies regardless of the quote grand total and of the remaining budget amount, so the budget does not have to be exceeded for the block to take effect. Regular, non-recurring checkouts are not affected—there, the **Require Approval** rule behaves as described above. ## Relationship to the Approval Process Spryker's existing Approval Process triggers a workflow when a buyer's order exceeds their *Buy up to grand total* permission. The Purchasing Control feature adds a parallel check: an order might be within a buyer's personal permission limit but still exceed the cost center's remaining budget. Both checks run independently at checkout. If either the permission limit or the budget rule is triggered, the configured action - block, warn, or require approval - is applied. This gives companies layered spending governance: per-person limits *and* per-department or per-project limits. {% info_block infoBox "Permissions required for the Require Approval enforcement rule" %} To use budgets with the **Require Approval** enforcement rule, the following [Approval Process](/docs/pbc/all/cart-and-checkout/latest/base-shop/feature-overviews/approval-process-feature-overview.html) permissions must be assigned to the relevant company roles: | PERMISSION | REQUIRES | | --- | --- | | Buy up to grand total | Send cart for approval | | Send cart for approval | Buy up to grand total | | Approve up to grand total | None | {% endinfo_block %} {% info_block warningBox "Approvals within a business unit" %} Approvers can only approve orders of employees within their own business unit. This constraint applies to both permission-based and budget-based approval requests. {% endinfo_block %} ## Cost centers and budgets in the procurement workflow The typical B2B procurement flow involving cost centers and budgets: 1. **Finance sets budgets.** At the start of a fiscal period, finance allocates budgets to each cost center. 2. **Buyers are assigned to cost centers.** Buyers are linked to one or more cost centers they are authorized to purchase against. Cost centers are linked to company business units, so all users in a business unit are automatically assigned to the corresponding cost centers. 3. **Orders are tagged.** At checkout, the buyer selects the cost center the purchase is charged to and the budget it is drawn from. Both fields are saved together in a single step: - The budget dropdown offers the budgets of every cost center available to the buyer, narrowed to the selected cost center. - Changing the cost center narrows the budget list immediately, without reloading the page. If the previously selected budget does not belong to the new cost center, the budget field is cleared. - If the selected cost center has no active budgets, the budget field is hidden and a message states that no budgets are available. - A budget that is selected must belong to the selected cost center. The pairing is validated on the server, so a mismatched combination is rejected even when the browser-side filtering is bypassed. - The selector form does not enforce a budget selection by itself, but the field is marked as required in the browser whenever the selected cost center has active budgets. An order cannot be placed without an active budget: if the buyer's business unit has active cost centers and no active budget is resolved, checkout fails and the buyer is asked to select a cost center and a budget. 4. **Budget is validated.** The system checks whether the order total fits within the remaining budget for the selected cost center. 5. **Enforcement rules apply.** Based on the configured rule, the order is blocked, a warning is shown, or approval is required. 6. **Budget is consumed.** Once the order is confirmed, the budget balance is reduced by the order amount. 7. **Budget is restored.** If the order is cancelled or refunded, the budget balance is restored by the amount corresponding to the cancelled or refunded items. For partial cancellations or refunds, only the amounts of the affected items are restored. ## Checkout validation outcomes | SCENARIO | OUTCOME | | --- | --- | | Within budget and within permission limit | Buyer completes checkout without additional steps. | | Exceeds budget - Warn rule | A warning is displayed; the buyer can proceed to checkout. | | Exceeds budget - Require Approval rule | The order is sent for approval; the buyer cannot complete checkout until approved. | | Exceeds Buy up to grand total permission limit | The order is sent for approval, same as the standard Approval Process. | | Exceeds budget - Block rule | Checkout is blocked; no approval option is available. | | Recurring order with a Require Approval budget | Checkout is blocked, whether or not the budget is exceeded. The buyer must select a budget bound to the Block or Warn rule. | | No active budget resolved while the business unit has active cost centers | Checkout fails; the buyer must select a cost center and a budget before placing the order. | ## Quote lock When an order is sent for approval - whether triggered by a budget rule or a permission limit - the quote is locked to preserve the order state during the approval review. Neither the buyer nor the approver can modify the quote while it is pending approval. For details, see [Quote lock functionality](/docs/pbc/all/cart-and-checkout/latest/base-shop/feature-overviews/approval-process-feature-overview.html#quote-lock-functionality). ## Cost centers and budgets on quote requests Buyers do not have to wait until checkout to attribute spending. The same cost center and budget selection is available on quote requests, so a purchase is assigned to a cost center while it is still being negotiated. {% info_block infoBox "Info" %} Cost center selection on quote requests requires the [Quotation Process](/docs/pbc/all/request-for-quote/latest/install-and-upgrade/install-features/install-the-quotation-process-feature.html) feature. {% endinfo_block %} | CONTEXT | WHERE THE SELECTION IS AVAILABLE | | --- | --- | | Buyer (Storefront) | Quote request details page and quote request edit page in the company area. | | Agent (Storefront) | Agent quote request details page and agent quote request edit page. | ### Cost centers follow the quote request owner Cost centers are scoped per company business unit. On a quote request, the applicable cost centers are those of the business unit that owns the request - the business unit of the company user who created it - and not those of the person currently viewing it. An agent working on a customer's quote request therefore sees the customer's cost centers rather than their own. Buyers can only change the cost center on their own quote requests. A quote request reference that belongs to another company user is treated as not found, so an unauthorized reference is indistinguishable from a reference that does not exist. ### Editability On a quote request, selecting a budget is optional: there is no checkout to pass, so a quote request is saved with a cost center and no budget. A budget that is selected must still belong to the selected cost center. A cost center and a budget can be changed only while the quote request is in an editable status. The status check runs on the server, so a quote request that is no longer editable is rejected even when the form is submitted directly. Quote requests that are not editable still display the assigned cost center and budget as read-only. ## Roles and capabilities | ROLE | CAPABILITIES | | --- | --- | | Site Operator (Back Office) | Create, update, activate, and deactivate cost centers. Assign cost centers to business units. Create and manage budgets with amount, period, currency, and enforcement rule. View the **Cost Center** column in the orders table. Filter and search orders by cost center and budget. View spend-vs-budget reports. Export reports to CSV. Review the audit log. Import cost centers, budgets, and business unit assignments in bulk using data import. | | Cost Center Manager (Storefront) | Create, update, activate, and deactivate cost centers and budgets from the company area. Requires the **Manage Cost Centers** permission assigned to their company role. | | Buyer (Storefront) | Select a cost center and budget at checkout. Assign a cost center and budget to their own quote requests. View the remaining budget for the selected cost center. Submit orders for approval when required. Filter order history by cost center and budget. View the assigned cost center and budget on order detail pages. | | Approver (Storefront) | Review locked quotes pending approval. Approve or reject orders, including those triggered by budget rules. | | Agent (Storefront) | Assign a cost center and budget to a customer's quote request on the customer's behalf, using the cost centers of the quote request owner's business unit. | ## Related Developer documents | INSTALLATION GUIDES | | --- | | [Install the Purchasing Control feature](/docs/pbc/all/cart-and-checkout/latest/base-shop/install-and-upgrade/install-features/install-the-purchasing-control-feature.html) | | MIGRATION GUIDES | | --- | | [Upgrade the PurchasingControl module](/docs/pbc/all/cart-and-checkout/latest/base-shop/install-and-upgrade/upgrade-modules/upgrade-the-purchasingcontrol-module.html) |

Install the Purchasing Control feature

Tue, 25 Aug 2026 08:40:54 +0000

This document describes how to install the [Purchasing Control feature](/docs/pbc/all/cart-and-checkout/latest/base-shop/feature-overviews/purchasing-control-feature-overview.html). ## Install feature core Follow the steps below to install the Purchasing Control feature core. ### Prerequisites To start feature integration, review and install the necessary features: | NAME | VERSION | INSTALLATION GUIDE | | --- | --- | --- | | Spryker Core | {{page.release_tag}} | [Install the Spryker Core feature](/docs/pbc/all/miscellaneous/latest/install-and-upgrade/install-features/install-the-spryker-core-feature.html) | | Company Account | {{page.release_tag}} | [Install the Company Account feature](/docs/pbc/all/customer-relationship-management/latest/base-shop/install-and-upgrade/install-features/install-the-company-account-feature.html) | | Checkout | {{page.release_tag}} | [Install the Checkout feature](/docs/pbc/all/cart-and-checkout/latest/base-shop/install-and-upgrade/install-features/install-the-checkout-feature.html) | | Approval Process | {{page.release_tag}} | [Install the Approval Process feature](/docs/pbc/all/cart-and-checkout/latest/base-shop/install-and-upgrade/install-features/install-the-approval-process-feature.html) | | Quotation Process | {{page.release_tag}} | [Install the Quotation Process feature](/docs/pbc/all/request-for-quote/latest/install-and-upgrade/install-features/install-the-quotation-process-feature.html) | {% info_block infoBox "Quotation Process" %} The Quotation Process feature is required only if you want buyers and agents to assign cost centers and budgets to quote requests. The `spryker/quote-request` and `spryker/quote-request-agent` modules are installed as dependencies of `spryker-feature/purchasing-control` in either case, but the Storefront quote request pages are only available with the Quotation Process feature installed. If you do not need this part of the feature, skip [Integrate cost centers with quote requests](#integrate-cost-centers-with-quote-requests). {% endinfo_block %} ### 1) Install the required modules ```bash composer require spryker-feature/purchasing-control:"^2.0.0" spryker/sales:"^11.83.0" spryker/sales-extension:"^1.15.0" spryker-shop/checkout-page:"^3.40.0" spryker-shop/company-page:"^2.36.0" spryker-shop/customer-page:"^2.77.0" spryker-shop/shop-ui:"^1.108.0" --update-with-dependencies --ignore-platform-req=ext-grpc ``` ### 2) Set up database schema and transfer objects Apply database changes and generate entity and transfer changes: ```bash console propel:install console transfer:generate ``` {% info_block warningBox "Verification" %} Make sure the following changes have been applied in the database: | DATABASE ENTITY | TYPE | EVENT | | --- | --- | --- | | spy_cost_center | table | created | | spy_cost_center_to_company_business_unit | table | created | | spy_budget | table | created | | spy_budget_consumption | table | created | | spy_quote.fk_cost_center | column | created | | spy_quote.fk_budget | column | created | | spy_sales_order.fk_cost_center | column | created | | spy_sales_order.fk_budget | column | created | Make sure the following changes have been applied in transfer objects: | TRANSFER | TYPE | EVENT | PATH | | --- | --- | --- | --- | | CostCenter | class | created | src/Generated/Shared/Transfer/CostCenterTransfer.php | | CostCenterCollection | class | created | src/Generated/Shared/Transfer/CostCenterCollectionTransfer.php | | CostCenterCriteria | class | created | src/Generated/Shared/Transfer/CostCenterCriteriaTransfer.php | | CostCenterConditions | class | created | src/Generated/Shared/Transfer/CostCenterConditionsTransfer.php | | CostCenterCollectionRequest | class | created | src/Generated/Shared/Transfer/CostCenterCollectionRequestTransfer.php | | CostCenterCollectionResponse | class | created | src/Generated/Shared/Transfer/CostCenterCollectionResponseTransfer.php | | CostCenterResponse | class | created | src/Generated/Shared/Transfer/CostCenterResponseTransfer.php | | CostCenterQuoteUpdateRequest | class | created | src/Generated/Shared/Transfer/CostCenterQuoteUpdateRequestTransfer.php | | CostCenterQuoteUpdateResponse | class | created | src/Generated/Shared/Transfer/CostCenterQuoteUpdateResponseTransfer.php | | Budget | class | created | src/Generated/Shared/Transfer/BudgetTransfer.php | | BudgetCollection | class | created | src/Generated/Shared/Transfer/BudgetCollectionTransfer.php | | BudgetCriteria | class | created | src/Generated/Shared/Transfer/BudgetCriteriaTransfer.php | | BudgetConditions | class | created | src/Generated/Shared/Transfer/BudgetConditionsTransfer.php | | BudgetCollectionRequest | class | created | src/Generated/Shared/Transfer/BudgetCollectionRequestTransfer.php | | BudgetCollectionResponse | class | created | src/Generated/Shared/Transfer/BudgetCollectionResponseTransfer.php | | BudgetResponse | class | created | src/Generated/Shared/Transfer/BudgetResponseTransfer.php | | BudgetConsumption | class | created | src/Generated/Shared/Transfer/BudgetConsumptionTransfer.php | | BudgetConsumptionCollection | class | created | src/Generated/Shared/Transfer/BudgetConsumptionCollectionTransfer.php | | BudgetConsumptionCriteria | class | created | src/Generated/Shared/Transfer/BudgetConsumptionCriteriaTransfer.php | | BudgetConsumptionConditions | class | created | src/Generated/Shared/Transfer/BudgetConsumptionConditionsTransfer.php | | Quote.idCostCenter | property | created | src/Generated/Shared/Transfer/QuoteTransfer.php | | Quote.idBudget | property | created | src/Generated/Shared/Transfer/QuoteTransfer.php | | Quote.costCenter | property | created | src/Generated/Shared/Transfer/QuoteTransfer.php | | Quote.budget | property | created | src/Generated/Shared/Transfer/QuoteTransfer.php | | Order.fkCostCenter | property | created | src/Generated/Shared/Transfer/OrderTransfer.php | | Order.fkBudget | property | created | src/Generated/Shared/Transfer/OrderTransfer.php | | Order.costCenter | property | created | src/Generated/Shared/Transfer/OrderTransfer.php | | Order.budget | property | created | src/Generated/Shared/Transfer/OrderTransfer.php | | OrderTableCriteria.costCenterIds | property | created | src/Generated/Shared/Transfer/OrderTableCriteriaTransfer.php | | OrderTableCriteria.budgetIds | property | created | src/Generated/Shared/Transfer/OrderTableCriteriaTransfer.php | {% endinfo_block %} ### 3) Set up data import Register the following data import plugins: | PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | | --- | --- | --- | --- | | CostCenterDataImportPlugin | Imports cost centers from `cost_center.csv`. Creates or updates cost centers by key, name, description, and active status. | None | SprykerFeature\Zed\PurchasingControl\Communication\Plugin\DataImport | | BudgetDataImportPlugin | Imports budgets from `budget.csv`. Resolves the cost center by key and creates or updates budgets by cost center and name. | None | SprykerFeature\Zed\PurchasingControl\Communication\Plugin\DataImport | | CostCenterToCompanyBusinessUnitDataImportPlugin | Imports cost center to company business unit relations from `cost_center_company_business_unit.csv`. Skips already existing relations. | None | SprykerFeature\Zed\PurchasingControl\Communication\Plugin\DataImport | **src/Pyz/Zed/DataImport/DataImportDependencyProvider.php** ```php */ protected function getDataImporterPlugins(): array { return [ // ... new CostCenterDataImportPlugin(), #PurchasingControlFeature new BudgetDataImportPlugin(), #PurchasingControlFeature new CostCenterToCompanyBusinessUnitDataImportPlugin(), #PurchasingControlFeature ]; } } ``` Create the CSV import files: **data/import/common/common/cost_center.csv** ```csv key,name,description,is_active cc-marketing,Marketing,Marketing and communications expenses,1 cc-it,IT & Operations,IT infrastructure and software licenses,1 ``` **data/import/common/common/budget.csv** ```csv cost_center_key,name,amount,currency_iso_code,starts_at,ends_at,enforcement_rule,is_active cc-marketing,Marketing Q2 2026,50000,EUR,2026-04-01,2026-06-30,warn,1 cc-it,IT Software Licenses 2026,100000,EUR,2026-01-01,2026-12-31,block,1 cc-it,IT Hardware Approvals 2026,200000,EUR,2026-01-01,2026-12-31,require_approval,1 ``` **data/import/common/common/cost_center_company_business_unit.csv** ```csv cost_center_key,business_unit_key cc-marketing,spryker_systems_berlin cc-it,spryker_systems_berlin ``` Import the data: ```bash console data:import purchasing-control-cost-center console data:import purchasing-control-budget console data:import purchasing-control-cost-center-to-company-business-unit ``` {% info_block warningBox "Verification" %} In the Back Office, under **Customers > Cost Centers**, make sure the imported cost centers and budgets are displayed. Make sure the cost centers are assigned to the expected business units. {% endinfo_block %} ### 4) Set up behavior Enable the following behaviors by registering the plugins. #### Set up Zed plugins | PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | | --- | --- | --- | --- | | ManageCostCentersPermissionPlugin | Grants permission to create, update, and manage cost centers. Assign this permission to company roles that should have access to Purchasing Control management pages. | None | SprykerFeature\Shared\PurchasingControl\Plugin\Permission | | BudgetCheckoutPreConditionPlugin | Validates the cart grand total against the remaining budget before checkout proceeds. Blocks checkout or triggers the approval flow depending on the budget enforcement rule. | None | SprykerFeature\Zed\PurchasingControl\Communication\Plugin\Checkout | | CostCenterOrderSaverPlugin | Saves the selected cost center and budget references to the sales order during checkout. | None | SprykerFeature\Zed\PurchasingControl\Communication\Plugin\Checkout | | ConsumeBudgetCheckoutPostSavePlugin | Records budget consumption immediately after the order is saved so the remaining budget balance is accurate for concurrent buyers. Does nothing when no budget is selected on the quote. | None | SprykerFeature\Zed\PurchasingControl\Communication\Plugin\Checkout | | CostCenterQuoteExpanderPlugin | Expands the quote with the default cost center assigned to the buyer's business unit when no cost center is already set. | None | SprykerFeature\Zed\PurchasingControl\Communication\Plugin\Quote | | CostCenterQuoteFieldsAllowedForSavingProviderPlugin | Adds `idCostCenter` and `idBudget` to the list of quote fields persisted to the database. | None | SprykerFeature\Zed\PurchasingControl\Communication\Plugin\Quote | | RestoreBudgetOnCancelOmsCommandPlugin | Restores the budget balance by deducting the amount of the canceled order items. Also deducts the shipment group total if all items in the group are canceled. | None | SprykerFeature\Zed\PurchasingControl\Communication\Plugin\Oms | | RestoreBudgetOnRefundOmsCommandPlugin | Restores the budget balance by deducting the refundable amount of the refunded order items. When refund with shipment is enabled, also deducts the shipment group expense refundable amount if all items in the group are refunded. | None | SprykerFeature\Zed\PurchasingControl\Communication\Plugin\Oms | | CostCenterOrderExpanderPlugin | Expands `OrderTransfer` with the assigned cost center and company name, and with the assigned budget when present. Does nothing when no cost center is assigned to the order. | None | SprykerFeature\Zed\PurchasingControl\Communication\Plugin\Sales | | CostCenterSearchOrderExpanderPlugin | Expands each `OrderTransfer` in a list with `CostCenterTransfer` and `BudgetTransfer` when assigned. Used for order search results. | None | SprykerFeature\Zed\PurchasingControl\Communication\Plugin\Sales | | CostCenterOrderSearchQueryExpanderPlugin | Expands `QueryJoinCollectionTransfer` with `WHERE` conditions for `fk_cost_center` and `fk_budget` when filter fields of type `costCenter` or `budget` are present. | None | SprykerFeature\Zed\PurchasingControl\Communication\Plugin\Sales | | CostCenterOrdersTableQueryExpanderPlugin | Adds a `LEFT JOIN` from `spy_sales_order.fk_cost_center` to `spy_cost_center.id_cost_center` and exposes `cost_center_name` as a virtual column on the Back Office orders table query. | None | SprykerFeature\Zed\PurchasingControl\Communication\Plugin\Sales | | CostCenterOrdersTableHeaderExpanderPlugin | Inserts a **Cost Center** column before the **Actions** column in the Back Office orders table. | None | SprykerFeature\Zed\PurchasingControl\Communication\Plugin\Sales | | CostCenterOrdersTableFilterFormExpanderPlugin | Adds cost center and budget multi-select filter fields to the Back Office orders table filter form. Budget choices are loaded via AJAX filtered by the selected cost centers. | None | SprykerFeature\Zed\PurchasingControl\Communication\Plugin\Sales | | CostCenterOrdersTableCriteriaFilterExpanderPlugin | Filters the Back Office orders table by `costCenterIds` and `budgetIds` when present on `OrderTableCriteriaTransfer`. | None | SprykerFeature\Zed\PurchasingControl\Communication\Plugin\Sales | | CostCenterSalesTablePlugin | Normalizes the `cost_center_name` column to `-` for orders that have no cost center assigned. | None | SprykerFeature\Zed\PurchasingControl\Communication\Plugin\Sales | #### Set up permissions **src/Pyz/Zed/Permission/PermissionDependencyProvider.php** ```php */ protected function getPermissionPlugins(): array { return [ // ... new ManageCostCentersPermissionPlugin(), #PurchasingControlFeature ]; } } ``` **src/Pyz/Client/Permission/PermissionDependencyProvider.php** ```php */ protected function getPermissionPlugins(): array { return [ // ... new ManageCostCentersPermissionPlugin(), #PurchasingControlFeature ]; } } ``` Sync the permission plugins to the database: ```bash console sync:data permission ``` {% info_block warningBox "Verification" %} In the Back Office, under **Customers > Company Roles**, assign the **ManageCostCentersPermissionPlugin** permission to a company role. Make sure company users with that role can access the cost center management pages on the Storefront. {% endinfo_block %} {% info_block infoBox "Require Approval enforcement rule" %} If you configure budgets with the **Require Approval** enforcement rule, the following [Approval Process](/docs/pbc/all/cart-and-checkout/latest/base-shop/install-and-upgrade/install-features/install-the-approval-process-feature.html) permissions must be registered and assigned to company roles for the approval workflow to function: | PERMISSION | REQUIRES | | --- | --- | | Buy up to grand total (`PlaceOrderPermissionPlugin`) | Send cart for approval | | Send cart for approval (`RequestQuoteApprovalPermissionPlugin`) | Buy up to grand total | | Approve up to grand total (`ApproveQuotePermissionPlugin`) | None | For plugin registration details, see [Install the Approval Process feature](/docs/pbc/all/cart-and-checkout/latest/base-shop/install-and-upgrade/install-features/install-the-approval-process-feature.html). {% endinfo_block %} #### Set up Checkout plugins **src/Pyz/Zed/Checkout/CheckoutDependencyProvider.php** ```php */ protected function getCheckoutPreConditions(Container $container): array { return [ // ... new BudgetCheckoutPreConditionPlugin(), #PurchasingControlFeature ]; } /** * @param \Spryker\Zed\Kernel\Container $container * * @return list<\Spryker\Zed\Checkout\Dependency\Plugin\CheckoutSaveOrderInterface|\Spryker\Zed\CheckoutExtension\Dependency\Plugin\CheckoutDoSaveOrderInterface> */ protected function getCheckoutOrderSavers(Container $container): array { return [ // ... new CostCenterOrderSaverPlugin(), #PurchasingControlFeature ]; } /** * @param \Spryker\Zed\Kernel\Container $container * * @return list<\Spryker\Zed\CheckoutExtension\Dependency\Plugin\CheckoutPostSaveInterface> */ protected function getCheckoutPostHooks(Container $container): array { return [ // ... new ConsumeBudgetCheckoutPostSavePlugin(), #PurchasingControlFeature ]; } } ``` {% info_block warningBox "Verification" %} When a buyer places an order with a budget selected, verify the following: - Checkout is blocked when the order exceeds a budget with the **Block** enforcement rule. - An approval request is triggered when the order exceeds a budget with the **Require Approval** rule. - A warning is displayed when the order exceeds a budget with the **Warn** rule. - A `spy_budget_consumption` record is created after the order is successfully placed. - The cost center and budget IDs are saved on the `spy_sales_order` record. {% endinfo_block %} #### Set up Quote plugins **src/Pyz/Zed/Quote/QuoteDependencyProvider.php** ```php */ protected function getQuoteExpanderPlugins(): array { return [ // ... new CostCenterQuoteExpanderPlugin(), #PurchasingControlFeature ]; } /** * @return array<\Spryker\Zed\QuoteExtension\Dependency\Plugin\QuoteFieldsAllowedForSavingProviderPluginInterface> */ protected function getQuoteFieldsAllowedForSavingProviderPlugins(): array { return [ // ... new CostCenterQuoteFieldsAllowedForSavingProviderPlugin(), #PurchasingControlFeature ]; } } ``` {% info_block warningBox "Verification" %} When a buyer with an assigned business unit opens a cart, make sure the quote is automatically expanded with the default cost center of their business unit. Make sure `idCostCenter` and `idBudget` are persisted to the `spy_quote` table when the quote is saved. {% endinfo_block %} #### Set up Sales plugins **src/Pyz/Zed/Sales/SalesDependencyProvider.php** ```php */ protected function getOrderHydrationPlugins(): array { return [ // ... new CostCenterOrderExpanderPlugin(), #PurchasingControlFeature ]; } /** * @return array<\Spryker\Zed\SalesExtension\Dependency\Plugin\SearchOrderExpanderPluginInterface> */ protected function getSearchOrderExpanderPlugins(): array { return [ // ... new CostCenterSearchOrderExpanderPlugin(), #PurchasingControlFeature ]; } /** * @return array<\Spryker\Zed\SalesExtension\Dependency\Plugin\SearchOrderQueryExpanderPluginInterface> */ protected function getOrderSearchQueryExpanderPlugins(): array { return [ // ... new CostCenterOrderSearchQueryExpanderPlugin(), #PurchasingControlFeature ]; } /** * @return array<\Spryker\Zed\SalesExtension\Dependency\Plugin\OrdersTableQueryExpanderPluginInterface> */ protected function getOrdersTableQueryExpanderPlugins(): array { return [ // ... new CostCenterOrdersTableQueryExpanderPlugin(), #PurchasingControlFeature ]; } /** * @return array<\Spryker\Zed\SalesExtension\Dependency\Plugin\OrdersTableHeaderExpanderPluginInterface> */ protected function getOrdersTableHeaderExpanderPlugins(): array { return [ // ... new CostCenterOrdersTableHeaderExpanderPlugin(), #PurchasingControlFeature ]; } /** * @return array<\Spryker\Zed\SalesExtension\Dependency\Plugin\OrdersTableFilterFormExpanderPluginInterface> */ protected function getOrdersTableFilterFormExpanderPlugins(): array { return [ // ... new CostCenterOrdersTableFilterFormExpanderPlugin(), #PurchasingControlFeature ]; } /** * @return array<\Spryker\Zed\SalesExtension\Dependency\Plugin\OrdersTableCriteriaFilterExpanderPluginInterface> */ protected function getOrdersTableCriteriaFilterExpanderPlugins(): array { return [ // ... new CostCenterOrdersTableCriteriaFilterExpanderPlugin(), #PurchasingControlFeature ]; } /** * @return array<\Spryker\Zed\SalesExtension\Dependency\Plugin\SalesTablePluginInterface> */ protected function getSalesTablePlugins(): array { return [ // ... new CostCenterSalesTablePlugin(), #PurchasingControlFeature ]; } } ``` {% info_block warningBox "Verification" %} - In the Back Office, open **Sales > Orders**. Make sure the **Cost Center** column is displayed in the orders table. - Make sure the orders table filter form includes cost center and budget multi-select fields. - Open an individual order. Make sure the cost center and budget names are displayed on the order detail page. - In the storefront, open **My Account > Orders**. Make sure the cost center and budget data appear on completed orders. {% endinfo_block %} #### Set up Recurring Orders plugins {% info_block infoBox "Recurring Orders feature" %} This step is only required if your project uses the [Recurring Orders feature](/docs/pbc/all/order-experience-management/latest/base-shop/feature-overviews/recurring-orders-feature-overview.html). The plugins belong to the Purchasing Control module but register in the `OrderExperienceManagement` dependency providers. {% endinfo_block %} | PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | | --- | --- | --- | --- | | BudgetApprovalRuleRecurringOrderCheckoutValidatorPlugin | Blocks checkout when a quote being set up as a recurring order carries a budget with the `require_approval` enforcement rule. Applies regardless of the quote grand total and the remaining budget amount. Passes when no budget is selected or the budget uses another enforcement rule. | Recurring Orders feature | SprykerFeature\Zed\PurchasingControl\Communication\Plugin\OrderExperienceManagement | | CostCenterRecurringOrderApproveFormExpanderPlugin | Adds cost center and budget dropdowns to the recurring order review approve form and validates the selected pair server-side. | Recurring Orders feature | SprykerFeature\Yves\PurchasingControl\Plugin\OrderExperienceManagement | | CostCenterRecurringScheduleEditFormExpanderPlugin | Adds cost center and budget dropdowns to the recurring schedule edit form and validates the selected pair server-side. | Recurring Orders feature | SprykerFeature\Yves\PurchasingControl\Plugin\OrderExperienceManagement | **src/Pyz/Zed/OrderExperienceManagement/OrderExperienceManagementDependencyProvider.php** ```php */ protected function getRecurringOrderCheckoutValidatorPlugins(): array { return [ new BudgetApprovalRuleRecurringOrderCheckoutValidatorPlugin(), #PurchasingControlFeature ]; } } ``` For the two Yves form expander plugins and the budget enforcement rules that can be selected on the recurring order forms, see [Install the Recurring Orders feature](/docs/pbc/all/order-experience-management/latest/base-shop/install-and-upgrade/install-features/install-the-recurring-orders-feature.html). {% info_block warningBox "Verification" %} Set a budget's enforcement rule to **Require approval**, assign it to a cart, and set up that cart as a recurring order at checkout. Make sure checkout is blocked with a message stating that the selected budget requires approval and cannot be used for a recurring order. {% endinfo_block %} ### 5) Configure Back Office navigation Add the Purchasing Control section to the Back Office navigation: **config/Zed/navigation.xml** ```xml ... ... Cost Centers Cost Centers purchasing-control cost-center index ``` Rebuild the navigation cache: ```bash console navigation:build-cache ``` {% info_block warningBox "Verification" %} In the Back Office, under **Customers**, make sure the **Cost Centers** menu item is displayed and links to the cost center list page. {% endinfo_block %} ### 6) Configure the OMS process Register the OMS command plugins and configure the OMS process XML. #### Register OMS command plugins **src/Pyz/Zed/Oms/OmsDependencyProvider.php** ```php extend(self::COMMAND_PLUGINS, function (CommandCollectionInterface $commandCollection) { // ... $commandCollection->add(new RestoreBudgetOnCancelOmsCommandPlugin(), 'CostCenter/RestoreBudgetOnCancel'); #PurchasingControlFeature $commandCollection->add(new RestoreBudgetOnRefundOmsCommandPlugin(), 'CostCenter/RestoreBudgetOnRefund'); #PurchasingControlFeature return $commandCollection; }); return $container; } } ``` #### Configure the OMS process XML Add the `CostCenter/RestoreBudgetOnCancel` and `CostCenter/RestoreBudgetOnRefund` commands to the relevant events in your OMS process XML. The following example uses `DummyPayment01`: **config/Zed/oms/DummyPayment01.xml** ```xml ... ... ``` #### Configure budget restoration behavior By default, shipment costs are not included when restoring the budget on refund. To include shipment costs, override `isRefundWithShipmentEnabled()` in your project config: **src/Pyz/Zed/PurchasingControl/PurchasingControlConfig.php** ```php */ protected function getGlobalWidgets(): array { return [ // ... CostCenterMenuItemWidget::class, #PurchasingControlFeature PurchasingControlSummaryWidget::class, #PurchasingControlFeature CostCenterSelectorWidget::class, #PurchasingControlFeature CostCenterDetailWidget::class, #PurchasingControlFeature CostCenterOrderDetailWidget::class, #PurchasingControlFeature CostCenterBudgetFilterWidget::class, #PurchasingControlFeature ]; } } ``` {% info_block infoBox "Where CostCenterDetailWidget is rendered" %} Unlike the other widgets in this table, no Purchasing Control template calls `CostCenterDetailWidget`. It renders only where another template calls it explicitly. In the demo shop, its single caller is the recurring order detail sidebar of the [Recurring Orders feature](/docs/pbc/all/order-experience-management/latest/base-shop/feature-overviews/recurring-orders-feature-overview.html). To display the assigned cost center and budget elsewhere—on the cart page or a quote detail page, for example—call the widget from that template: ```twig {% raw %}{% widget 'CostCenterDetailWidget' args [data.quote] only %}{% endwidget %}{% endraw %} ``` Pass a second argument to add a budget usage summary—the total, used, and remaining amounts, plus a used-percentage bar—below the cost center and budget names: ```twig {% raw %}{% widget 'CostCenterDetailWidget' args [data.quote, true] only %}{% endwidget %}{% endraw %} ``` The summary is rendered by the `recurring-order-budget-summary` molecule the module ships. It is omitted when the argument is `false` or not passed, and also when the quote carries no budget or no currency. {% endinfo_block %} {% info_block warningBox "Verification" %} - Make sure all six widgets are available in Twig templates. - On the storefront company dashboard, make sure the **Purchasing Control** summary widget displays cost center and budget data. - On the checkout summary page, make sure the cost center and budget selector is displayed. - On the order detail page, make sure the assigned cost center and budget names are displayed. - On the order history page, make sure the cost center and budget filter controls are displayed. - Call `CostCenterDetailWidget` from a template with a quote that has a cost center assigned, and make sure the cost center and budget names are displayed. Deactivate that cost center and make sure the names are no longer displayed. {% endinfo_block %} ### 3) Extend the ShopUi select component Extend the ShopUi `select` atom to render HTML attributes for the cost center and budget selectors: **src/Pyz/Yves/ShopUi/Theme/default/components/atoms/select/select.twig** ```twig {% raw %}{% block attributes %} {%- for attrname, attrvalue in attr | default({}) -%} {%- if attrvalue is same as(true) -%} {{ attrname }}="{{ attrname }}" {%- elseif attrvalue is not same as(false) -%} {{ attrname }}="{{ attrvalue }}" {%- endif -%} {%- endfor -%} {% endblock %}{% endraw %} ``` {% info_block warningBox "Verification" %} Make sure the cost center and budget dropdowns correctly disable unavailable options. Select a cost center and make sure the budget dropdown offers only the budgets of that cost center, and that budgets of other cost centers are both hidden and disabled. {% endinfo_block %} ### 4) Extend the checkout summary template Add the `CostCenterSelectorWidget` to the checkout summary page, placing it directly above the `QuoteApprovalWidget` call: **src/SprykerShop/CheckoutPage/src/SprykerShop/Yves/CheckoutPage/Theme/default/views/summary/summary.twig** ```twig

{% raw %}{% widget 'CostCenterSelectorWidget' args [data.cart] only %}{% endwidget %}{% endraw %} {% raw %}{% widget 'QuoteApprovalWidget' args [data.cart] only %}{% endwidget %}{% endraw %}

``` {% info_block warningBox "Verification" %} On the checkout summary page, make sure the cost center and budget selector is displayed above the approval widget. {% endinfo_block %} ### 5) Set up routes Register the following route provider plugins: | PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | | --- | --- | --- | --- | | CostCenterRouteProviderPlugin | Adds storefront routes for cost center list, create, update, and quote update actions. Also adds the POST-only routes that update the cost center and budget of a quote request in the customer and agent contexts. | None | SprykerFeature\Yves\PurchasingControl\Plugin\Router | | BudgetRouteProviderPlugin | Adds storefront routes for budget list, create, and update actions. | None | SprykerFeature\Yves\PurchasingControl\Plugin\Router | **src/Pyz/Yves/Router/RouterDependencyProvider.php** ```php */ protected function getRouteProvider(): array { return [ // ... new CostCenterRouteProviderPlugin(), #PurchasingControlFeature new BudgetRouteProviderPlugin(), #PurchasingControlFeature ]; } } ``` {% info_block warningBox "Verification" %} - Make sure the cost center list, create, and update pages are accessible under `/company/cost-center`. - Make sure submitting the cost center selector form in the cart updates the quote with the selected cost center and budget. - Make sure the budget list, create, and update pages are accessible. {% endinfo_block %} ### 6) Extend the order search form Register the following plugins to add cost center and budget filter fields to the storefront order history search form: | PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | | --- | --- | --- | --- | | CostCenterOrderSearchFormExpanderPlugin | Adds cost center and budget filter dropdowns to the order history search form. Only adds fields when the current customer is a company user. | None | SprykerFeature\Yves\PurchasingControl\Plugin\CustomerPage | | CostCenterOrderSearchFormHandlerPlugin | Maps selected cost center and budget IDs from the filter form to `FilterFieldTransfer` entries on `OrderListTransfer`. | None | SprykerFeature\Yves\PurchasingControl\Plugin\CustomerPage | **src/Pyz/Yves/CustomerPage/CustomerPageDependencyProvider.php** ```php */ protected function getOrderSearchFormExpanderPlugins(): array { return [ // ... new CostCenterOrderSearchFormExpanderPlugin(), #PurchasingControlFeature ]; } /** * @return array<\SprykerShop\Yves\CustomerPageExtension\Dependency\Plugin\OrderSearchFormHandlerPluginInterface> */ protected function getOrderSearchFormHandlerPlugins(): array { return [ // ... new CostCenterOrderSearchFormHandlerPlugin(), #PurchasingControlFeature ]; } } ``` {% info_block warningBox "Verification" %} On the storefront **My Account > Orders** page, make sure company users see cost center and budget filter dropdowns. Make sure filtering by cost center or budget returns the expected orders. {% endinfo_block %} ## Integrate cost centers with quote requests Follow the steps below to let buyers and agents assign a cost center and a budget to a quote request. Skip this section if you do not use quote requests. {% info_block infoBox "Prerequisites" %} This part of the feature requires the [Quotation Process](/docs/pbc/all/request-for-quote/latest/install-and-upgrade/install-features/install-the-quotation-process-feature.html) feature. {% endinfo_block %} ### 1) Install the required modules ```bash composer require spryker-shop/quote-request-page:"^3.8.0" spryker-shop/quote-request-agent-page:"^3.7.0" --update-with-dependencies ``` {% info_block warningBox "Verification" %} Make sure the following modules are installed at the specified versions or higher: | MODULE | EXPECTED VERSION | | --- | --- | | QuoteRequestPage | 3.8.0 | | QuoteRequestAgentPage | 3.7.0 | {% endinfo_block %} ### 2) Allow the cost center and budget quote fields for saving Add `ID_COST_CENTER` and `ID_BUDGET` to the quote fields that are persisted with a quote request version. Without this configuration, both fields are stripped when the quote request version is saved: the update appears to succeed, but the selection is lost. **src/Pyz/Zed/QuoteRequest/QuoteRequestConfig.php** ```php */ public function getQuoteFieldsAllowedForSaving(): array { return array_merge(parent::getQuoteFieldsAllowedForSaving(), [ // ... QuoteTransfer::ID_COST_CENTER, #PurchasingControlFeature QuoteTransfer::ID_BUDGET, #PurchasingControlFeature ]); } } ``` {% info_block warningBox "Verification" %} Assign a cost center and a budget to a quote request, then reload the quote request details page. Make sure the selection is still displayed. In the database, make sure `spy_quote_request_version.quote` contains the `idCostCenter` and `idBudget` values. {% endinfo_block %} ### 3) Set up widgets Register the following global widgets: | WIDGET | DESCRIPTION | NAMESPACE | | --- | --- | --- | | QuoteRequestCostCenterSelectorWidget | Renders the cost center and budget selection UI on the quote request details and quote request edit pages. Takes a `QuoteRequestTransfer` and an optional form action route name. When the route name is omitted, the form posts to `company/cost-center/update-quote-request`. | SprykerFeature\Yves\PurchasingControl\Widget | | QuoteRequestAgentCostCenterSelectorWidget | Renders the same selection UI on the agent quote request details and agent quote request edit pages. Takes the same two arguments. When the route name is omitted, the form posts to `agent/quote-request/cost-center/update`. | SprykerFeature\Yves\PurchasingControl\Widget | **src/Pyz/Yves/ShopApplication/ShopApplicationDependencyProvider.php** ```php */ protected function getGlobalWidgets(): array { return [ // ... QuoteRequestCostCenterSelectorWidget::class, #PurchasingControlFeature QuoteRequestAgentCostCenterSelectorWidget::class, #PurchasingControlFeature ]; } } ``` Both widgets are rendered from a `costCenter` block in the `quote-request-details.twig` and `quote-request-edit.twig` templates of the `QuoteRequestPage` and `QuoteRequestAgentPage` modules. In a project that uses these templates as they are shipped, no template changes are required. To change or remove the placement, override the `costCenter` block. {% info_block warningBox "Template overrides" %} If your project overrides any of the four templates, the widget is not rendered on the affected pages, because your override replaces the module template that contains the `costCenter` block. Re-base your overrides against the new module templates, or add the `costCenter` block to them. {% endinfo_block %} The second argument controls where the form returns to after saving. The details pages omit it, so the widget falls back to the details route. The edit pages pass it explicitly: the `QuoteRequestPage` edit template passes `company/cost-center/update-quote-request-from-edit`, and the `QuoteRequestAgentPage` edit template passes `agent/quote-request/cost-center/update-from-edit`. Pass a route name of your own only if you also register a route that returns to your page. {% info_block infoBox "Info" %} The widgets suppress themselves when there is nothing to show. An editable quote request renders the selection form only if at least one cost center is available to the owner's business unit. A quote request that is not editable displays the assigned cost center and budget as read-only. {% endinfo_block %} {% info_block warningBox "Verification" %} - On the Storefront, open a quote request in an editable status and make sure the cost center and budget selection is displayed on both the details page and the edit page. - Select a cost center and a budget, then submit the form. Make sure a success message is displayed and the page returns to the details page or the edit page, depending on where you started. - Open a quote request that is not editable and make sure the assigned cost center and budget are displayed as read-only, without a submit button. - As an agent, open a customer's quote request and make sure the cost center dropdown lists the cost centers of the customer's business unit, not your own. {% endinfo_block %} ### 4) Review the quote request routes The `CostCenterRouteProviderPlugin` that you registered in [Set up routes](#5-set-up-routes) adds the following routes. All of them accept `POST` requests only, and each one determines its own return page, so the redirect target cannot be supplied by the request. | ROUTE NAME | PATH | RETURNS TO | | --- | --- | --- | | `company/cost-center/update-quote-request` | `/company/cost-center/update-quote-request/{quoteRequestReference}` | Quote request details page | | `company/cost-center/update-quote-request-from-edit` | `/company/cost-center/update-quote-request-from-edit/{quoteRequestReference}` | Quote request edit page | | `agent/quote-request/cost-center/update` | `/agent/quote-request/cost-center/update/{quoteRequestReference}` | Agent quote request details page | | `agent/quote-request/cost-center/update-from-edit` | `/agent/quote-request/cost-center/update-from-edit/{quoteRequestReference}` | Agent quote request edit page | The two `-from-edit` routes are reached only when a widget receives a form action route name as its second argument. For details, see [Set up widgets](#3-set-up-widgets). The two agent routes are deliberately placed under `/agent/` so that they are covered by the agent firewall. {% info_block warningBox "Verification" %} - Make sure a `GET` request to any of the four paths is rejected. - Make sure a buyer cannot update the cost center of a quote request that belongs to another company user: the request must return `404`, the same response as for a quote request reference that does not exist. - Make sure an anonymous request to either agent path is rejected by the agent firewall. {% endinfo_block %}

Install the Configuration Management feature

Tue, 25 Aug 2026 07:19:33 +0000

This document describes how to install the Configuration Management feature. ## Prerequisites Update the required modules: | NAME | VERSION | |----|---------| | Kernel | ^3.82 | | Store | ^1.36 | | Translator | ^1.15 | ## Install feature core ### 1) Install the required modules Install the required modules using Composer: ```bash composer require spryker/configuration:"^1.0.0" --update-with-dependencies ``` {% info_block warningBox "Verification" %} Make sure the following modules have been installed: | MODULE | EXPECTED DIRECTORY | | --- | --- | | Configuration | vendor/spryker/configuration | {% endinfo_block %} ### 2) Set up configuration Add the following configuration to extend scope support with store-level configuration: | CONFIGURATION | SPECIFICATION | NAMESPACE | | --- | --- | --- | | ConfigurationConfig | Adds `store` scope to available scopes and defines scope hierarchy (store inherits from global). | Pyz\Shared\Configuration | **src/Pyz/Shared/Configuration/ConfigurationConfig.php** ```php ' SPRYKER_CONFIGURATION_ENCRYPTION_INIT_VECTOR: '' ``` In Cloud, add environment variables using [Parameter Store](/docs/ca/dev/add-variables-in-the-parameter-store). To generate new keys, run: ```bash openssl rand -hex 32 # generates SPRYKER_CONFIGURATION_ENCRYPTION_KEY openssl rand -hex 16 # generates SPRYKER_CONFIGURATION_ENCRYPTION_INIT_VECTOR ``` {% info_block warningBox "Verification" %} 1. Create a setting with `secret: true` in a YAML schema and run `configuration:sync`. 2. Set a value for the secret setting in the Back Office. 3. Check the `spy_configuration_value` table — the stored value must be encrypted (not plain text). 4. Read the value back in the Back Office — it must be decrypted and displayed correctly. {% endinfo_block %} ### 3) Set up the database schema and transfer objects #### 3.1) Set up database schema extension Add event behavior to the `spy_configuration_value` table to enable Publish & Synchronize: **src/Pyz/Zed/Configuration/Persistence/Propel/Schema/spy_configuration.schema.xml** ```xml

``` #### 3.2) Apply database changes and generate transfers ```bash console propel:install console transfer:generate ``` {% info_block warningBox "Verification" %} Make sure that the following changes have been applied by checking your database: | DATABASE ENTITY | TYPE | EVENT | | --- | --- | --- | | spy_configuration_value | table | created | | spy_configuration_storage | table | created | {% endinfo_block %} {% info_block warningBox "Verification" %} Make sure the following changes in transfer objects have been applied: | TRANSFER | TYPE | EVENT | PATH | | --- | --- | --- | --- | | ConfigurationSetting | class | created | src/Generated/Shared/Transfer/ConfigurationSettingTransfer | | ConfigurationValue | class | created | src/Generated/Shared/Transfer/ConfigurationValueTransfer | | ConfigurationScope | class | created | src/Generated/Shared/Transfer/ConfigurationScopeTransfer | | ConfigurationFeature | class | created | src/Generated/Shared/Transfer/ConfigurationFeatureTransfer | | ConfigurationTab | class | created | src/Generated/Shared/Transfer/ConfigurationTabTransfer | | ConfigurationGroup | class | created | src/Generated/Shared/Transfer/ConfigurationGroupTransfer | | ConfigurationConstraint | class | created | src/Generated/Shared/Transfer/ConfigurationConstraintTransfer | | ConfigurationDependency | class | created | src/Generated/Shared/Transfer/ConfigurationDependencyTransfer | | ConfigurationSyncResponse | class | created | src/Generated/Shared/Transfer/ConfigurationSyncResponseTransfer | | ConfigurationSettingCollection | class | created | src/Generated/Shared/Transfer/ConfigurationSettingCollectionTransfer | | ConfigurationScopeCollection | class | created | src/Generated/Shared/Transfer/ConfigurationScopeCollectionTransfer | | ConfigurationValueRequest | class | created | src/Generated/Shared/Transfer/ConfigurationValueRequestTransfer | | ConfigurationValueResponse | class | created | src/Generated/Shared/Transfer/ConfigurationValueResponseTransfer | | ConfigurationValidationRequest | class | created | src/Generated/Shared/Transfer/ConfigurationValidationRequestTransfer | | ConfigurationValidationResponse | class | created | src/Generated/Shared/Transfer/ConfigurationValidationResponseTransfer | | ConfigurationError | class | created | src/Generated/Shared/Transfer/ConfigurationErrorTransfer | | ConfigurationValueCollectionRequest | class | created | src/Generated/Shared/Transfer/ConfigurationValueCollectionRequestTransfer | | ConfigurationValueDeletion | class | created | src/Generated/Shared/Transfer/ConfigurationValueDeletionTransfer | | ConfigurationValueCollectionResponse | class | created | src/Generated/Shared/Transfer/ConfigurationValueCollectionResponseTransfer | | ConfigurationSettingValuesCriteria | class | created | src/Generated/Shared/Transfer/ConfigurationSettingValuesCriteriaTransfer | | ConfigurationSettingValueCollection | class | created | src/Generated/Shared/Transfer/ConfigurationSettingValueCollectionTransfer | | ConfigurationStorage | class | created | src/Generated/Shared/Transfer/ConfigurationStorageTransfer | | ConfigurationFileUpload | class | created | src/Generated/Shared/Transfer/ConfigurationFileUploadTransfer | | ConfigurationFileUploadCollectionRequest | class | created | src/Generated/Shared/Transfer/ConfigurationFileUploadCollectionRequestTransfer | | ConfigurationFileUploadCollectionResponse | class | created | src/Generated/Shared/Transfer/ConfigurationFileUploadCollectionResponseTransfer | {% endinfo_block %} ### 4) Add translations Regenerate the Zed translator cache to pick up the Configuration Management Back Office UI translations: ```bash console translator:generate-cache ``` {% info_block warningBox "Verification" %} 1. Navigate to the Configuration Management page in the Back Office. 2. Verify that all UI labels, buttons, and messages are displayed in the correct locale. 3. Switch to German locale and verify the German translations appear. {% endinfo_block %} ### 5) Configure navigation Add the Configuration Management entry to `config/Zed/navigation.xml`: ```xml Configuration Configuration Management settings configuration manage index 1 ``` Execute the following command to clear the navigation cache: ```bash console navigation:cache:remove ``` {% info_block warningBox "Verification" %} Log in to the Back Office and verify that the **Configuration** menu item appears in the main navigation sidebar. {% endinfo_block %} ### 6) Set up behavior #### 6.1) Register console commands and application plugin Register the configuration sync console command and the application plugin that exposes the Configuration facade as an application service for direct Zed access from the Client layer: | PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | | --- | --- | --- | --- | | ConfigurationSyncConsole | Synchronizes configuration schemas from YAML files and generates the merged schema and settings map. | None | Spryker\Zed\Configuration\Communication\Console | | ConfigurationApplicationPlugin | Registers the Configuration facade as an application service for direct access in Zed applications. | None | Spryker\Zed\Configuration\Communication\Plugin\Application | **src/Pyz/Zed/Console/ConsoleDependencyProvider.php** Add the import statements: ```php use Spryker\Zed\Configuration\Communication\Console\ConfigurationSyncConsole; use Spryker\Zed\Configuration\Communication\Plugin\Application\ConfigurationApplicationPlugin; ``` Register the console command in `getConsoleCommands()`: ```php protected function getConsoleCommands(Container $container): array { $commands = [ // ... new ConfigurationSyncConsole(), // ... ]; } ``` Register the application plugin in `getApplicationPlugins()`: ```php protected function getApplicationPlugins(Container $container): array { $applicationPlugins = parent::getApplicationPlugins($container); // ... $applicationPlugins[] = new ConfigurationApplicationPlugin(); return $applicationPlugins; } ``` **src/Pyz/Zed/Application/ApplicationDependencyProvider.php** Add the import statement: ```php use Spryker\Zed\Configuration\Communication\Plugin\Application\ConfigurationApplicationPlugin; ``` Register the application plugin in each Zed application context (`getBackofficeApplicationPlugins()`, `getBackendGatewayApplicationPlugins()`, `getBackendApiApplicationPlugins()`): ```php protected function getBackofficeApplicationPlugins(): array { return [ // ... new ConfigurationApplicationPlugin(), ]; } protected function getBackendGatewayApplicationPlugins(): array { return [ // ... new ConfigurationApplicationPlugin(), ]; } protected function getBackendApiApplicationPlugins(): array { return [ // ... new ConfigurationApplicationPlugin(), ]; } ``` {% info_block warningBox "Verification" %} 1. Run `console configuration:sync` and verify that it outputs the number of processed settings. 2. Verify that configuration values can be read in Zed context via the Client layer without going through storage. {% endinfo_block %} #### 6.2) Set up queue configuration Register the Configuration storage synchronization queue in both message broker implementations. **src/Pyz/Client/RabbitMq/RabbitMqConfig.php** Add the import statement: ```php use Spryker\Shared\Configuration\ConfigurationConstants; ``` Add the queue name to `getSynchronizationQueueConfiguration()`: ```php protected function getSynchronizationQueueConfiguration(): array { return [ // ... ConfigurationConstants::QUEUE_NAME_SYNC_CONFIGURATION, ]; } ``` **src/Pyz/Client/SymfonyMessenger/SymfonyMessengerConfig.php** Add the import statement: ```php use Spryker\Shared\Configuration\ConfigurationConstants; ``` Add the queue name to `getSynchronizationQueueConfiguration()`: ```php protected function getSynchronizationQueueConfiguration(): array { return [ // ... ConfigurationConstants::QUEUE_NAME_SYNC_CONFIGURATION, ]; } ``` {% info_block warningBox "Verification" %} Run `console queue:setup` and verify that the `sync.storage.configuration` queue is created in RabbitMQ. {% endinfo_block %} #### 6.3) Register queue message processor Register the synchronization storage queue message processor for the Configuration sync queue: **src/Pyz/Zed/Queue/QueueDependencyProvider.php** Add the import statements: ```php use Spryker\Shared\Configuration\ConfigurationConstants; ``` Add the processor to `getProcessorMessagePlugins()`: ```php protected function getProcessorMessagePlugins(Container $container): array { return [ // ... ConfigurationConstants::QUEUE_NAME_SYNC_CONFIGURATION => new SynchronizationStorageQueueMessageProcessorPlugin(), ]; } ``` {% info_block warningBox "Verification" %} 1. Save a configuration value in the Back Office. 2. Run `console queue:worker:start --stop-when-empty`. 3. Verify that the `sync.storage.configuration` queue is processed without errors. {% endinfo_block %} #### 6.4) Register publisher plugins Enable Publish & Synchronize for configuration values by registering the publisher plugin: | PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | | --- | --- | --- | --- | | ConfigurationValueWritePublisherPlugin | Publishes storefront-visible, non-secret configuration values to `spy_configuration_storage` when `spy_configuration_value` entities are created, updated, or deleted. | None | Spryker\Zed\Configuration\Communication\Plugin\Publisher | **src/Pyz/Zed/Publisher/PublisherDependencyProvider.php** Add the import statement: ```php use Spryker\Zed\Configuration\Communication\Plugin\Publisher\ConfigurationValueWritePublisherPlugin; ``` Register the plugin group in `getPublisherPlugins()`: ```php protected function getPublisherPlugins(): array { return array_merge( // ... $this->getConfigurationStoragePlugins(), ); } ``` Add the new method: ```php /** * @return list<\Spryker\Zed\PublisherExtension\Dependency\Plugin\PublisherPluginInterface> */ protected function getConfigurationStoragePlugins(): array { return [ new ConfigurationValueWritePublisherPlugin(), ]; } ``` {% info_block warningBox "Verification" %} 1. Save a configuration value in the Back Office. 2. Check that the `spy_configuration_storage` table contains the published value. 3. Verify that secret settings are NOT published to storage. {% endinfo_block %} #### 6.5) Register scope identifier provider plugins Register the store scope identifier provider to resolve the current store name as the scope identifier: | PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | | --- | --- | --- | --- | | StoreConfigurationScopeIdentifierProviderPlugin | Provides the current store name as the scope identifier for the `store` scope. | Store module installed | Spryker\Zed\Store\Communication\Plugin\Configuration | **src/Pyz/Zed/Configuration/ConfigurationDependencyProvider.php** ```php */ protected function getScopeIdentifierProviderPlugins(): array { return [ new StoreConfigurationScopeIdentifierProviderPlugin(), ]; } } ``` {% info_block warningBox "Verification" %} 1. Navigate to the Configuration Management page in the Back Office. 2. Switch the scope selector to a specific store. 3. Verify that the scope identifier resolves to the store name (for example `DE`, `AT`). {% endinfo_block %} #### 6.6) Register Client-level request expander plugins Register the store scope expander to attach the current store scope to configuration value requests: | PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | | --- | --- | --- | --- | | StoreScopeConfigurationValueRequestExpanderPlugin | Expands the configuration value request with the current store scope and store name as scope identifier. | Store module installed | Spryker\Client\Store\Plugin\Configuration | **src/Pyz/Client/Configuration/ConfigurationDependencyProvider.php** ```php