Install the Service Points Cart feature

Last updated:
Edit on GitHub

This document describes how to install the Service Points Cart feature.

Prerequisites

Install the required features:

NAME VERSION INSTALLATION GUIDE
Service Points 202311.0 Install the Service Points feature
Cart 202311.0 Install the Cart feature

1) Install the required modules

Install the required modules using Composer:

composer require spryker-feature/service-points-cart: "202311.0" --update-with-dependencies
composer require spryker/service-point-carts-rest-api:"^1.0.0" --update-with-dependencies
Verification

Make sure that the following modules have been installed:

MODULE EXPECTED DIRECTORY
ServicePointCart vendor/spryker/service-point-cart
ServicePointCartExtension vendor/spryker/service-point-cart-extension
ServicePointCartPage vendor/spryker-shop/service-point-cart-page
ServicePointCartsRestApi vendor/spryker/service-point-carts-rest-api

2) Add translations

  1. Append the glossary according to your configuration:
>service_point_cart.checkout.validation.error,Selected service point "%uuid%" is not available for the store "%store_name%",en_US
service_point_cart.checkout.validation.error,Der ausgewählte Servicepunkt "%uuid%" ist für den Shop "%store_name%" nicht verfügbar,de_DE

3) Set up behavior

Register the plugins:

PLUGIN SPECIFICATION PREREQUISITES NAMESPACE
ServicePointCheckoutPreConditionPlugin Validates if QuoteTransfer.items.servicePoint is active and available for the current store. Spryker\Zed\ServicePointCart\Communication\Plugin\Checkout
ReplaceServicePointQuoteItemsQuoteMapperPlugin If shipments are provided, replaces quote items using an applicable strategy. Spryker\Zed\ServicePointCartsRestApi\Communication\Plugin\CheckoutRestApi

src/Pyz/Zed/Checkout/CheckoutDependencyProvider.php

<?php

namespace Pyz\Zed\Checkout;

use Spryker\Zed\Checkout\CheckoutDependencyProvider as SprykerCheckoutDependencyProvider;
use Spryker\Zed\ServicePointCart\Communication\Plugin\Checkout\ServicePointCheckoutPreConditionPlugin;

class CheckoutDependencyProvider extends SprykerCheckoutDependencyProvider
{
    /**
     * @param \Spryker\Zed\Kernel\Container $container
     *
     * @return array<\Spryker\Zed\CheckoutExtension\Dependency\Plugin\CheckoutPreConditionPluginInterface>
     */
    protected function getCheckoutPreConditions(Container $container): array
    {
        return [
            new ServicePointCheckoutPreConditionPlugin(),
        ];
    }
Verification
  1. Add an item to cart and proceed to checkout.
  2. Select a service point.
  3. Deactivate the service point.
  4. Proceed to the Summary page. On the Summary page, make sure you get the validation error.

src/Pyz/Zed/CheckoutRestApi/CheckoutRestApiDependencyProvider.php

<?php

namespace Pyz\Zed\CheckoutRestApi;

use Spryker\Zed\CheckoutRestApi\CheckoutRestApiDependencyProvider as SprykerCheckoutRestApiDependencyProvider;
use Spryker\Zed\ServicePointCartsRestApi\Communication\Plugin\CheckoutRestApi\ReplaceServicePointQuoteItemsQuoteMapperPlugin;

class CheckoutRestApiDependencyProvider extends SprykerCheckoutRestApiDependencyProvider
{
    /**
     * @return array<\Spryker\Zed\CheckoutRestApiExtension\Dependency\Plugin\QuoteMapperPluginInterface>
     */
    protected function getQuoteMapperPlugins(): array
    {
        return [
            new ReplaceServicePointQuoteItemsQuoteMapperPlugin() # Has to be placed before PaymentsQuoteMapperPlugin
        ];
    }
Verification
  1. Prepare two product offers for the same product:
  2. With support for the pickup shipment type and a connection to a service point.
  3. Without support for the pickup shipment type.
  4. Using Glue API, add the product offer 2 to cart.
  5. Using the checkout-data endpoint, select a service point for the item. Make sure the selected service point is returned in the response. Make sure the product offer 2 has been replaced with the product offer 1.