Install the Merchant Portal - Marketplace Merchant Portal Product Offer Management feature

Last updated:
Edit on GitHub

This document describes how to install the Marketplace Merchant Portal Product Offer Management feature.

Prerequisites

Install the required features:

NAME VERSION INSTALLATION GUIDE
Marketplace Product Offer 202404.0 Install the Marketplace Product Offer feature
Marketplace Merchant Portal Core 202404.0 Install the Merchant Portal Core feature

1) Install the required modules

Install the required modules using Composer:

composer require spryker-feature/marketplace-merchant-portal-product-offer-management:"202404.0" --update-with-dependencies
Verification

Make sure the following modules have been installed:

MODULE EXPECTED DIRECTORY
ProductOfferMerchantPortalGui vendor/spryker/product-offer-merchant-portal-gui

2) Set up transfer objects

Generate transfer changes:

console transfer:generate
Verification

Make sure the following changes have been applied in transfer objects:

TRANSFER TYPE EVENT PATH
MerchantProductOfferCounts class Created src/Generated/Shared/Transfer/MerchantProductOfferCountsTransfer
MerchantStockCriteria.merchantReference property Created src/Generated/Shared/Transfer/MerchantStockCriteriaTransfer
PriceProductOfferCriteria.volumeQuantities property Created src/Generated/Shared/Transfer/PriceProductOfferCriteriaTransfer
PriceProductOfferTableCriteria class Created src/Generated/Shared/Transfer/PriceProductOfferTableCriteriaTransfer
PriceProductOfferTableView class Created src/Generated/Shared/Transfer/PriceProductOfferTableViewTransfer
PriceProductOfferTableViewCollection class Created src/Generated/Shared/Transfer/PriceProductOfferTableViewCollectionTransfer
ProductConcrete.numberOfOffers property Created src/Generated/Shared/Transfer/ProductConcreteTransfer
ProductConcrete.productOfferStock property Created src/Generated/Shared/Transfer/ProductConcreteTransfer
ProductOffer.createdAt property Created src/Generated/Shared/Transfer/ProductOfferTransfer
ProductOffer.productAttributes property Created src/Generated/Shared/Transfer/ProductOfferTransfer
ProductOffer.productImages property Created src/Generated/Shared/Transfer/ProductOfferTransfer
ProductOffer.productLocalizedAttributes property Created src/Generated/Shared/Transfer/ProductOfferTransfer
ProductOffer.updatedAt property Created src/Generated/Shared/Transfer/ProductOfferTransfer
ProductOfferCollection.pagination property Created src/Generated/Shared/Transfer/ProductOfferCollectionTransfer
ProductOfferCriteria.merchantIds property Created src/Generated/Shared/Transfer/ProductOfferTransfer
ProductOfferTableCriteria class Created src/Generated/Shared/Transfer/ProductOfferTableCriteriaTransfer
ProductTableCriteria class Created src/Generated/Shared/Transfer/ProductTableCriteriaTransfer
Item.merchantSku property Created src/Generated/Shared/Transfer/ItemTransfer
ProductOfferFormViewCollection class Created src/Generated/Shared/Transfer/ProductOfferFormViewCollection
ProductOfferFormView class Created src/Generated/Shared/Transfer/ProductOfferFormView

3) Add translations

Generate translation cache for Zed:

console translator:generate-cache

4) Set up behavior

  1. Enable the following behaviors by registering the plugins:
PLUGIN SPECIFICATION PREREQUISITES NAMESPACE
OffersMerchantDashboardCardPlugin Adds the Offers pane to the Dashboard page. Spryker\Zed\ProductOfferMerchantPortalGui\Communication\Plugin\DashboardMerchantPortalGui

src/Pyz/Zed/DashboardMerchantPortalGui/DashboardMerchantPortalGuiDependencyProvider.php

<?php

namespace Pyz\Zed\DashboardMerchantPortalGui;

use Spryker\Zed\DashboardMerchantPortalGui\DashboardMerchantPortalGuiDependencyProvider as SprykerDashboardMerchantPortalGuiDependencyProvider;
use Spryker\Zed\ProductOfferMerchantPortalGui\Communication\Plugin\DashboardMerchantPortalGui\OffersMerchantDashboardCardPlugin;
class DashboardMerchantPortalGuiDependencyProvider extends SprykerDashboardMerchantPortalGuiDependencyProvider
{
    /**
     * @return array<\Spryker\Zed\DashboardMerchantPortalGuiExtension\Dependency\Plugin\MerchantDashboardCardPluginInterface>
     */
    protected function getDashboardCardPlugins(): array
    {
        return [
            new OffersMerchantDashboardCardPlugin(),
        ];
    }
}
Verification

In the Merchant Portal, go to Dashboard. On the Dashboard page, make sure the Offers pane is displayed.

FEATURE REQUIRED FOR THE CURRENT FEATURE INTEGRATION GUIDE
Merchant Portal - Marketplace Merchant Portal Product Offer Management + Merchant Portal Order Management Install the Merchant Portal - Marketplace Merchant Portal Product Offer Management + Marketplace Order Management feature