Install the Cart + Prices feature

Last updated:
Edit on GitHub

Install feature core

The following feature integration guide expects the basic feature to be in place. The current feature integration guide only adds the Cart Prices functionality.

Prerequisites

Install the required features:

NAME VERSION INSTALLATION GUIDE
Cart 202311.0 Cart feature integration
Prices 202311.0 Install the Prices feature
Marketplace Product Offer Prices (Optional) 202311.0 Install the Marketplace Product Offer Prices feature

1) Install the required modules

composer require spryker/price-cart-connector:"^6.9.0" --update-with-dependencies
“Verification”

Make sure that the following modules have been installed:

MODULE EXPECTED DIRECTORY
PriceCartConnector vendor/spryker/price-cart-connector

2) Set up configuration

Set up the following configuration:

src/Pyz/Zed/PriceCartConnector/PriceCartConnectorConfig.php

<?php

namespace Pyz\Zed\PriceCartConnector;

use Spryker\Zed\PriceCartConnector\PriceCartConnectorConfig as SprykerPriceCartConnectorConfig;

class PriceCartConnectorConfig extends SprykerPriceCartConnectorConfig
{
    /**
     * @var bool
     */
    protected const IS_ZERO_PRICE_ENABLED_FOR_CART_ACTIONS = false;
    
    /**
     * @return list<string>
     */
    public function getItemFieldsForIdentifier(): array
    {
        return array_merge(parent::getItemFieldsForIdentifier(), [
            ItemTransfer::SKU,
            ItemTransfer::QUANTITY,
            ...
        ]);
    }
}

If IS_ZERO_PRICE_ENABLED_FOR_CART_ACTIONS=false while attempting to add the product with zero price to the cart, you get the following message: “Price in selected currency not found for product with sku ‘%sku%’. Please change the currency or remove product from order.”

The PriceCartConnectorConfig::getItemFieldsForIdentifier() lets you set up a list of fields that are used to build item identifiers. Based on generated identifiers, the system can recognize duplicate items and perform requests only for unique items.

Warning

Apply the following changes only if you have the Marketplace Product Offer Prices feature installed.

src/Pyz/Zed/PriceCartConnector/PriceCartConnectorConfig.php

<?php

namespace Pyz\Zed\PriceCartConnector;

use Spryker\Zed\PriceCartConnector\PriceCartConnectorConfig as SprykerPriceCartConnectorConfig;

class PriceCartConnectorConfig extends SprykerPriceCartConnectorConfig
{
    ...

    /**
     * @return list<string>
     */
    public function getItemFieldsForIdentifier(): array
    {
        return array_merge(parent::getItemFieldsForIdentifier(), [
            ItemTransfer::SKU,
            ItemTransfer::QUANTITY,
            ItemTransfer::MERCHANT_REFERENCE,
            ItemTransfer::PRODUCT_OFFER_REFERENCE,
        ]);
    }
}

3) Generate transfer objects

console transfer:generate
Verification

Ensure the following transfers have been created:

TRANSFER TYPE EVENT PATH
Item class created src/Generated/Shared/Transfer/ItemTransfer
Quote class created src/Generated/Shared/Transfer/QuoteTransfer
Store class created src/Generated/Shared/Transfer/StoreTransfer
PriceProductFilter class created src/Generated/Shared/Transfer/PriceProductFilterTransfer
CartChange class created src/Generated/Shared/Transfer/CartChangeTransfer
CartPreCheckResponse class created src/Generated/Shared/Transfer/CartPreCheckResponseTransfer
Message class created src/Generated/Shared/Transfer/MessageTransfer
PriceProduct class created src/Generated/Shared/Transfer/PriceProductTransfer
Currency class created src/Generated/Shared/Transfer/CurrencyTransfer
MoneyValue class created src/Generated/Shared/Transfer/MoneyValueTransfer
CartItemQuantity class created src/Generated/Shared/Transfer/CartItemQuantityTransfer

4) Set up behavior

Register the following plugins:

PLUGIN SPECIFICATION PREREQUISITES NAMESPACE
CartItemPricePlugin Adds product prices to item, based on currency, price mode, and price type. None Spryker\Zed\PriceCartConnector\Communication\Plugin
CartItemPricePreCheckPlugin Validates product prices, checks if prices are valid for current currency, price mode, and price type combination. None Spryker\Zed\PriceCartConnector\Communication\Plugin
FilterItemsWithoutPricePlugin Removes quote items without price. None Spryker\Zed\PriceCartConnector\Communication\Plugin
SanitizeSourcePricesQuoteLockPreResetPlugin Sanitizes source prices in quote items. None Spryker\Zed\PriceCartConnector\Communication\Plugin\Cart
src/Pyz/Zed/Cart/CartDependencyProvider.php 
<?php

namespace Pyz\Zed\Cart;

use Spryker\Zed\Cart\CartDependencyProvider as SprykerCartDependencyProvider;
use Spryker\Zed\Kernel\Container;
use Spryker\Zed\PriceCartConnector\Communication\Plugin\Cart\SanitizeSourcePricesQuoteLockPreResetPlugin;
use Spryker\Zed\PriceCartConnector\Communication\Plugin\CartItemPricePlugin;
use Spryker\Zed\PriceCartConnector\Communication\Plugin\CartItemPricePreCheckPlugin;
use Spryker\Zed\PriceCartConnector\Communication\Plugin\FilterItemsWithoutPricePlugin;

class CartDependencyProvider extends SprykerCartDependencyProvider
{
    /**
     * @param \Spryker\Zed\Kernel\Container $container
     *
     * @return array<\Spryker\Zed\CartExtension\Dependency\Plugin\ItemExpanderPluginInterface>
     */
    protected function getExpanderPlugins(Container $container): array
    {
        return [
           new CartItemPricePlugin(),
        ];
    }
	
    /**
     * @param \Spryker\Zed\Kernel\Container $container
     *
     * @return array<\Spryker\Zed\CartExtension\Dependency\Plugin\CartPreCheckPluginInterface>
     */
    protected function getCartPreCheckPlugins(Container $container): array
    {
        return [
            new CartItemPricePreCheckPlugin(),
        ];
    }
	
    /**
     * @param \Spryker\Zed\Kernel\Container $container
     *
     * @return array<\Spryker\Zed\CartExtension\Dependency\Plugin\PreReloadItemsPluginInterface>
     */
    protected function getPreReloadPlugins(Container $container): array
    {
        return [
            new FilterItemsWithoutPricePlugin(),
        ];
    }
	
    /**
     * @return array<\Spryker\Zed\CartExtension\Dependency\Plugin\QuoteLockPreResetPluginInterface>
     */
    protected function getQuoteLockPreResetPlugins(): array
    {
        return [
            new SanitizeSourcePricesQuoteLockPreResetPlugin(),
        ];
    }
}