diff --git a/_includes/pbc/all/install-features/202304.0/install-the-product-offer-shipment-feature.md b/_includes/pbc/all/install-features/202304.0/install-the-product-offer-shipment-feature.md index fa3696de3b9..8fd986783a3 100644 --- a/_includes/pbc/all/install-features/202304.0/install-the-product-offer-shipment-feature.md +++ b/_includes/pbc/all/install-features/202304.0/install-the-product-offer-shipment-feature.md @@ -1,4 +1,6 @@ -This document describes how to integrate the Product offer shipment feature into a Spryker project. + + +This document describes how to integrate the Product Offer Shipment feature into a Spryker project. ## Install feature core @@ -10,10 +12,10 @@ To start feature integration, integrate the following required features: | NAME | VERSION | INTEGRATION GUIDE | |---------------|------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------| - | Product Offer | {{site.version}} | [Product Offer feature integration](/docs/marketplace/dev/feature-integration-guides/{{site.version}}/marketplace-product-offer-feature-integration.html) | - | Shipment | {{site.version}} | [Shipment feature integration](/docs/pbc/all/carrier-management/{{page.version}}/install-and-upgrade/install-the-shipment-feature.html) | +| Product Offer | {{site.version}} | [Product Offer feature integration](/docs/marketplace/dev/feature-integration-guides/{{site.version}}/marketplace-product-offer-feature-integration.html) | +| Shipment | {{site.version}} | [Shipment feature integration](/docs/pbc/all/carrier-management/{{page.version}}/install-and-upgrade/install-the-shipment-feature.html) | -## Install the required modules using Composer +## 1) Install the required modules using Composer ```bash composer require spryker-feature/product-offer-shipment:"{{site.version}}" --update-with-dependencies @@ -23,155 +25,287 @@ composer require spryker-feature/product-offer-shipment:"{{site.version}}" --upd Make sure that the following module has been installed: -| MODULE | EXPECTED DIRECTORY | -|--------------------------|--------------------------------------------| -| ProductOffer | vendor/spryker/product-offer | -| Shipment | vendor/spryker/shipment | -| ProductOfferShipmentType | vendor/spryker/product-offer-shipment-type | +| MODULE | EXPECTED DIRECTORY | +|------------------------------------------|--------------------------------------------------------------| +| ProductOfferShipmentType | vendor/spryker/product-offer-shipment-type | +| ProductOfferShipmentTypeDataImport | vendor/spryker/product-offer-shipment-type-data-import | +| ProductOfferShipmentTypeStorage | vendor/spryker/product-offer-shipment-type-storage | +| ProductOfferShipmentTypeStorageExtension | vendor/spryker/product-offer-shipment-type-storage-extension | {% endinfo_block %} -### Set up behavior +### 2) Set up database schema and transfer objects -Enable the following plugins: +1. Adjust the schema definition so entity changes trigger events. -| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | -|------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------| -| ShipmentTypeProductOfferPostCreatePlugin | Persists product offer shipment type to persistence. | Requires `ProductOfferTransfer.productOfferReference` to be set. Requires `ShipmentTypeTransfer.shipmentTypeUuid` to be set for each `ShipmentTypeTransfer` in `ProductOfferTransfer.shipmentTypes` collection. | Spryker\Zed\ProductOfferShipmentType\Communication\Plugins\ProductOffer | -| ShipmentTypeProductOfferPostUpdatePlugin | Deletes redundant product offer shipment types from Persistence. Persists missed product offer shipment types to Persistence. | Requires `ProductOfferTransfer.productOfferReference` to be set. Requires `ShipmentTypeTransfer.shipmentTypeUuid` to be set for each `ShipmentTypeTransfer` in `ProductOfferTransfer.shipmentTypes` collection. | Spryker\Zed\ProductOfferShipmentType\Communication\Plugins\ProductOffer | -| ShipmentTypeProductOfferExpanderPlugin | Expands `ProductOfferTransfer` with related shipment types. | Requires `ProductOfferTransfer.productOfferReference` to be set | Spryker\Zed\ProductOfferShipmentType\Communication\Plugins\ProductOffer | +| AFFECTED ENTITY | TRIGGERED EVENTS | +|---------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------| +| spy_product_offer_shipment_type | Entity.spy_product_offer_shipment_type.create
Entity.spy_product_offer_shipment_type.update
Entity.spy_product_offer_shipment_type.delete | -**src/Pyz/Zed/ProductOffer/ProductOfferDependencyProvider.php** +**src/Pyz/Zed/ProductOfferShipmentType/Persistence/Propel/Schema/spy_product_offer_shipment_type.schema.xml** + +```xml + + + + + + + + +
+ + +``` + +2. Apply database changes and generate entity and transfer changes: + +```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_product_offer_shipment_type | table | created | +| spy_product_offer_shipment_type_storage | table | created | + +Ensure the following transfers have been created: + +| TRANSFER | TYPE | EVENT | PATH | +|------------------------------------|-------|---------|--------------------------------------------------------------------------| +| ProductOfferShipmentTypeCriteria | class | created | src/Generated/Shared/Transfer/ProductOfferShipmentTypeCriteriaTransfer | +| ProductOfferShipmentTypeConditions | class | created | src/Generated/Shared/Transfer/ProductOfferShipmentTypeConditionsTransfer | +| ProductOfferShipmentTypeCollection | class | created | src/Generated/Shared/Transfer/ProductOfferShipmentTypeCollectionTransfer | +| ProductOfferShipmentType | class | created | src/Generated/Shared/Transfer/ProductOfferShipmentTypeTransfer | +| ProductOfferShipmentTypeStorage | class | created | src/Generated/Shared/Transfer/ProductOfferShipmentTypeStorageTransfer | +| ProductOfferCriteria | class | created | src/Generated/Shared/Transfer/ProductOfferCriteriaTransfer | +| ProductOfferConditions | class | created | src/Generated/Shared/Transfer/ProductOfferConditionsTransfer | +| ProductOfferCollection | class | created | src/Generated/Shared/Transfer/ProductOfferCollectionTransfer | +| ProductOffer | class | created | src/Generated/Shared/Transfer/ProductOfferTransfer | +| ShipmentTypeCriteria | class | created | src/Generated/Shared/Transfer/ShipmentTypeCriteriaTransfer | +| ShipmentTypeConditions | class | created | src/Generated/Shared/Transfer/ShipmentTypeConditionsTransfer | +| ShipmentTypeCollection | class | created | src/Generated/Shared/Transfer/ShipmentTypeCollectionTransfer | +| ShipmentType | class | created | src/Generated/Shared/Transfer/ShipmentTypeTransfer | +| ProductOfferStorage | class | created | src/Generated/Shared/Transfer/ProductOfferStorageTransfer | +| ShipmentTypeStorageCriteria | class | created | src/Generated/Shared/Transfer/ShipmentTypeStorageCriteriaTransfer | +| ShipmentTypeStorageConditions | class | created | src/Generated/Shared/Transfer/ShipmentTypeStorageConditionsTransfer | +| ShipmentTypeStorageCollection | class | created | src/Generated/Shared/Transfer/ShipmentTypeStorageCollectionTransfer | +| ShipmentTypeStorage | class | created | src/Generated/Shared/Transfer/ShipmentTypeStorageTransfer | +| StoreCollection | class | created | src/Generated/Shared/Transfer/StoreCollectionTransfer | +| Store | class | created | src/Generated/Shared/Transfer/StoreTransfer | +| StoreRelation | class | created | src/Generated/Shared/Transfer/StoreRelationTransfer | +| Pagination | class | created | src/Generated/Shared/Transfer/PaginationTransfer | +| CartChange | class | created | src/Generated/Shared/Transfer/CartChangeTransfer | +| Sort | class | created | src/Generated/Shared/Transfer/SortTransfer | +| DataImporterConfiguration | class | created | src/Generated/Shared/Transfer/DataImportConfigurationTransfer | +| DataImporterReport | class | created | src/Generated/Shared/Transfer/DataImporterReportTransfer | +| EventEntity | class | created | src/Generated/Shared/Transfer/EventEntityTransfer | +| SynchronizationData | class | created | src/Generated/Shared/Transfer/SynchronizationDataTransfer | +| Filter | class | created | src/Generated/Shared/Transfer/FilterTransfer | + +{% endinfo_block %} + +### 3) Configure export to Redis + +Configure tables to be published to `spy_product_offer_shipment_type_storage` and synchronized to the Storage on create, edit, and delete changes: + +1. In `src/Pyz/Client/RabbitMq/RabbitMqConfig.php`, adjust the `RabbitMq` module configuration: + +**src/Pyz/Client/RabbitMq/RabbitMqConfig.php** ```php + * @return list */ - protected function getProductOfferPostCreatePlugins(): array + protected function getSynchronizationQueueConfiguration(): array { return [ - new ShipmentTypeProductOfferPostCreatePlugin(), + ProductOfferShipmentTypeStorageConfig::QUEUE_NAME_SYNC_STORAGE_PRODUCT_OFFER_SHIPMENT_TYPE, ]; } +} +``` + +2. Register the new queue message processor: + +**src/Pyz/Zed/Queue/QueueDependencyProvider.php** + +```php + + * @param \Spryker\Zed\Kernel\Container $container + * + * @return array */ - protected function getProductOfferPostUpdatePlugins(): array + protected function getProcessorMessagePlugins(Container $container): array { return [ - new ShipmentTypeProductOfferPostUpdatePlugin(), + ProductOfferShipmentTypeStorageConfig::QUEUE_NAME_SYNC_STORAGE_PRODUCT_OFFER_SHIPMENT_TYPE => new SynchronizationStorageQueueMessageProcessorPlugin(), ]; } +} + +``` + +3. Configure the synchronization pool and event queue name: +**src/Pyz/Zed/ShipmentTypeStorage/ShipmentTypeStorageConfig.php** + +```php + + * @return string|null */ - protected function getProductOfferExpanderPlugins(): array + public function getProductOfferShipmentTypeStorageSynchronizationPoolName(): ?string + { + return SynchronizationConfig::DEFAULT_SYNCHRONIZATION_POOL_NAME; + } +} +``` + +4. Set up publisher plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|---------------------------------------------------------------|--------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------| +| ProductOfferShipmentTypeWritePublisherPlugin | Publishes product offer shipment type data by `SpyProductOfferShipmentType` entity events. | Requires `productOfferReference` to be provided in `EventEntityTransfers.additionalValues`. | Spryker\Zed\ProductOfferShipmentTypeStorage\Communication\Plugin\Publisher\ProductOfferShipmentType | +| ProductOfferProductOfferShipmentTypeWritePublisherPlugin | Publishes product offer shipment type data by `SpyProductOffer` events. | | Spryker\Zed\ProductOfferShipmentTypeStorage\Communication\Plugin\Publisher\ProductOffer | +| ProductOfferStoreProductOfferShipmentTypeWritePublisherPlugin | Publishes product offer shipment type data by `SpyProductOfferStore` events. | | Spryker\Zed\ProductOfferShipmentTypeStorage\Communication\Plugin\Publisher\ProductOfferStore | +| ShipmentTypeProductOfferShipmentTypeWritePublisherPlugin | Publishes product offer shipment type data by `SpyShipmentType` events. | | Spryker\Zed\ProductOfferShipmentTypeStorage\Communication\Plugin\Publisher\ShipmentType | +| ShipmentTypeStoreProductOfferShipmentTypeWritePublisherPlugin | Publishes product offer shipment type data by `SpyShipmentTypeStore` events. | | Spryker\Zed\ProductOfferShipmentTypeStorage\Communication\Plugin\Publisher\ShipmentTypeStore | + +**src/Pyz/Zed/Publisher/PublisherDependencyProvider.php** + +```php +|array> + */ + protected function getPublisherPlugins(): array + { + return array_merge( + $this->getProductOfferShipmentTypeStoragePlugins(), + ); + } + + /** + * @return list<\Spryker\Zed\PublisherExtension\Dependency\Plugin\PublisherPluginInterface> + */ + protected function getProductOfferShipmentTypeStoragePlugins(): array { return [ - new ShipmentTypeProductOfferExpanderPlugin(), + new ProductOfferShipmentTypeWritePublisherPlugin(), + new ProductOfferProductOfferShipmentTypeWritePublisherPlugin(), + new ProductOfferStoreProductOfferShipmentTypeWritePublisherPlugin(), + new ShipmentTypeProductOfferShipmentTypeWritePublisherPlugin(), + new ShipmentTypeStoreProductOfferShipmentTypeWritePublisherPlugin(), ]; } +} ``` -### Set up database schema and transfer objects +5. Set up synchronization plugins: -```bash -console propel:install -console transfer:generate -``` +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|-----------------------------------------------------------------|------------------------------------------------------------------------------------------|---------------|----------------------------------------------------------------------------------| +| ProductOfferShipmentTypeSynchronizationDataBulkRepositoryPlugin | Allows synchronizing the product offer shipment type storage table's content into Redis. | | Spryker\Zed\ProductOfferShipmentTypeStorage\Communication\Plugin\Synchronization | -{% info_block warningBox "Verification" %} +**src/Pyz/Zed/Synchronization/SynchronizationDependencyProvider.php** -Make sure that the following changes have been applied by checking your database: +```php + + */ + protected function getSynchronizationDataPlugins(): array + { + return [ + new ProductOfferShipmentTypeSynchronizationDataBulkRepositoryPlugin(), + ]; + } +} +``` {% info_block warningBox "Verification" %} -Ensure the following transfers have been created: +Make sure that the `product-offer-shipment-type` data is stored in storage correctly: + +1. Fill the `spy_product_offer`, `spry_product_offer_store`, `spy_shipment_type`, `spy_shipment_type_store`, and `spy_product_offer_shipment_type` tables with data. +2. Run the `console publish:trigger-events -r product_offer` command. +3. Make sure that the `spy_product_offer_shipment_type_storage` table has been filled with respective data. +4. Make sure that, in your system, storage entries are displayed with the `kv:product_offer_shipment_type:{store}:{product_offer_reference}` mask. + +Make sure that `product-offer-shipment-type` synchronization plugin works correctly: -| TRANSFER | TYPE | EVENT | PATH | -|--------------------------------|-------|---------|----------------------------------------------------------------------| -| ProductOffer | class | created | src/Generated/Shared/Transfer/ProductOfferTransfer | -| ShipmentTypeCollection | class | created | src/Generated/Shared/Transfer/ShipmentTypeCollectionTransfer | -| ShipmentType | class | created | src/Generated/Shared/Transfer/ShipmentTypeTransfer | -| ShipmentTypeCriteria | class | created | src/Generated/Shared/Transfer/ShipmentTypeCriteriaTransfer | -| ShipmentTypeConditions | class | created | src/Generated/Shared/Transfer/ShipmentTypeConditionsTransfer | -| CartChange | class | created | src/Generated/Shared/Transfer/CartChangeTransfer | -| Item | class | created | src/Generated/Shared/Transfer/ItemTransfer | -| ProductOfferStore | class | created | src/Generated/Shared/Transfer/ProductOfferStoreTransfer | -| ProductOfferError | class | created | src/Generated/Shared/Transfer/ProductOfferErrorTransfer | -| ProductOfferCollection | class | created | src/Generated/Shared/Transfer/ProductOfferCollectionTransfer | -| ProductOfferCriteria | class | created | src/Generated/Shared/Transfer/ProductOfferCriteriaTransfer | -| ProductOfferConditions | class | created | src/Generated/Shared/Transfer/ProductOfferConditionsTransfer | -| Pagination | class | created | src/Generated/Shared/Transfer/PaginationTransfer | -| Quote | class | created | src/Generated/Shared/Transfer/QuoteTransfer | -| Store | class | created | src/Generated/Shared/Transfer/StoreTransfer | -| Message | class | created | src/Generated/Shared/Transfer/MessageTransfer | -| CartPreCheckResponse | class | created | src/Generated/Shared/Transfer/CartPreCheckResponseTransfer | -| CheckoutResponse | class | created | src/Generated/Shared/Transfer/CheckoutResponseTransfer | -| CheckoutError | class | created | src/Generated/Shared/Transfer/CheckoutErrorTransfer | -| CartItemQuantity | class | created | src/Generated/Shared/Transfer/CartItemQuantityTransfer | -| EventEntity | class | created | src/Generated/Shared/Transfer/EventEntityTransfer | -| AclEntityMetadataConfig | class | created | src/Generated/Shared/Transfer/AclEntityMetadataConfigTransfer | -| AclEntityMetadata | class | created | src/Generated/Shared/Transfer/AclEntityMetadataTransfer | -| AclEntityParentMetadata | class | created | src/Generated/Shared/Transfer/AclEntityParentMetadataTransfer | -| AclEntityMetadataCollection | class | created | src/Generated/Shared/Transfer/AclEntityMetadataCollectionTransfer | -| AclEntityRule | class | created | src/Generated/Shared/Transfer/AclEntityRuleTransfer | -| ShipmentCarrier | class | created | src/Generated/Shared/Transfer/ShipmentCarrierTransfer | -| ShipmentMethodPluginCollection | class | created | src/Generated/Shared/Transfer/ShipmentMethodPluginCollectionTransfer | -| ShipmentCarrierRequest | class | created | src/Generated/Shared/Transfer/ShipmentCarrierRequestTransfer | -| ShipmentMethods | class | created | src/Generated/Shared/Transfer/ShipmentMethodsTransfer | -| ShipmentMethod | class | created | src/Generated/Shared/Transfer/ShipmentMethodTransfer | -| ShipmentCriteria | class | created | src/Generated/Shared/Transfer/ShipmentCriteriaTransfer | -| ShipmentConditions | class | created | src/Generated/Shared/Transfer/ShipmentConditionsTransfer | -| ShipmentCollection | class | created | src/Generated/Shared/Transfer/ShipmentCollectionTransfer | -| SalesShipmentCriteria | class | created | src/Generated/Shared/Transfer/SalesShipmentCriteriaTransfer | -| SalesShipmentConditions | class | created | src/Generated/Shared/Transfer/SalesShipmentConditionsTransfer | -| SalesShipmentCollection | class | created | src/Generated/Shared/Transfer/SalesShipmentCollectionTransfer | -| Order | class | created | src/Generated/Shared/Transfer/OrderTransfer | -| Address | class | created | src/Generated/Shared/Transfer/AddressTransfer | -| Shipment | class | created | src/Generated/Shared/Transfer/ShipmentTransfer | -| SaveOrder | class | created | src/Generated/Shared/Transfer/SaveOrderTransfer | -| Expense | class | created | src/Generated/Shared/Transfer/ExpenseTransfer | -| MoneyValue | class | created | src/Generated/Shared/Transfer/MoneyValueTransfer | -| Money | class | created | src/Generated/Shared/Transfer/MoneyTransfer | -| ShipmentGroup | class | created | src/Generated/Shared/Transfer/ShipmentGroupTransfer | -| ShipmentMethodsCollection | class | created | src/Generated/Shared/Transfer/ShipmentMethodsCollectionTransfer | -| ShipmentPrice | class | created | src/Generated/Shared/Transfer/ShipmentPriceTransfer | -| ShipmentGroupResponse | class | created | src/Generated/Shared/Transfer/ShipmentGroupResponseTransfer | -| CalculableObject | class | created | src/Generated/Shared/Transfer/CalculableObjectTransfer | -| Mail | class | created | src/Generated/Shared/Transfer/MailTransfer | -| TaxSet | class | created | src/Generated/Shared/Transfer/TaxSetTransfer | -| Currency | class | created | src/Generated/Shared/Transfer/CurrencyTransfer | -| TaxSetCollection | class | created | src/Generated/Shared/Transfer/TaxSetCollectionTransfer | -| Country | class | created | src/Generated/Shared/Transfer/CountryTransfer | -| StoreRelation | class | created | src/Generated/Shared/Transfer/StoreRelationTransfer | -| Totals | class | created | src/Generated/Shared/Transfer/TotalsTransfer | -| Filter | class | created | src/Generated/Shared/Transfer/FilterTransfer | -| OrderFilter | class | created | src/Generated/Shared/Transfer/OrderFilterTransfer | -| Sort | class | created | src/Generated/Shared/Transfer/SortTransfer | +1. Fill the `spy_product_offer_shipment_type_storage` table with some data. +2. Run the `console sync:data -r product_offer_shipment_type` command. +3. Make sure that, in your system, storage entries are displayed with the `kv:product_offer_shipment_type:{store}:{product_offer_reference}` mask. +Make sure that when a product offer shipment type relation is created or edited through BAPI, it is exported to Redis accordingly. + +In Redis, make sure data is represented in the following format: +```json +{ + "product_offer_reference": "offer1", + "shipment_type_uuids": [ + "174d9dc0-55ae-5c4b-a2f2-a419027029ef" + ] +} +``` {% endinfo_block %} -### Import shipment types for product offers +### 4) Import shipment types for product offers 1. Prepare your data according to your requirements using our demo data: @@ -207,7 +341,7 @@ use Spryker\Zed\ProductOfferShipmentTypeDataImport\Communication\Plugin\DataImpo class DataImportDependencyProvider extends SprykerDataImportDependencyProvider { /** - * @return array + * @return list<\Spryker\Zed\DataImport\Dependency\Plugin\DataImportPluginInterface> */ protected function getDataImporterPlugins(): array { @@ -237,7 +371,7 @@ class ConsoleDependencyProvider extends SprykerConsoleDependencyProvider /** * @param \Spryker\Zed\Kernel\Container $container * - * @return \Symfony\Component\Console\Command\Command[] + * @return list<\Symfony\Component\Console\Command\Command> */ protected function getConsoleCommands(Container $container) { @@ -253,7 +387,7 @@ class ConsoleDependencyProvider extends SprykerConsoleDependencyProvider 4. Import data: ```bash -console data:import product-offer-shipment-type +console data:import:product-offer-shipment-type ``` {% info_block warningBox "Verification" %} @@ -261,3 +395,83 @@ console data:import product-offer-shipment-type Make sure that the configured data has been added to the `spy_product_offer_shipment_type` table in the database. {% endinfo_block %} + +### 5) Set up behavior + +Enable the following plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|-----------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------| +| ShipmentTypeProductOfferPostCreatePlugin | Persists product offer shipment type to persistence. | Requires `ProductOfferTransfer.productOfferReference` to be set. Requires `ShipmentTypeTransfer.shipmentTypeUuid` to be set for each `ShipmentTypeTransfer` in `ProductOfferTransfer.shipmentTypes` collection. | Spryker\Zed\ProductOfferShipmentType\Communication\Plugins\ProductOffer | +| ShipmentTypeProductOfferPostUpdatePlugin | Deletes redundant product offer shipment types from Persistence. Persists missed product offer shipment types to Persistence. | Requires `ProductOfferTransfer.productOfferReference` to be set. Requires `ShipmentTypeTransfer.shipmentTypeUuid` to be set for each `ShipmentTypeTransfer` in `ProductOfferTransfer.shipmentTypes` collection. | Spryker\Zed\ProductOfferShipmentType\Communication\Plugins\ProductOffer | +| ShipmentTypeProductOfferExpanderPlugin | Expands `ProductOfferTransfer` with related shipment types. | Requires `ProductOfferTransfer.productOfferReference` to be set | Spryker\Zed\ProductOfferShipmentType\Communication\Plugins\ProductOffer | +| ShipmentTypeProductOfferStorageExpanderPlugin | Expands `ProductOfferStorageTransfer` expanded with shipment type storage data. | Requires `ProductOfferStorageTransfer.productOfferReference` to be set. | Spryker\Zed\ProductOfferShipmentTypeStorage\Communication\Plugin\ProductOfferStorage | + +**src/Pyz/Zed/ProductOffer/ProductOfferDependencyProvider.php** + +```php + + */ + protected function getProductOfferPostCreatePlugins(): array + { + return [ + new ShipmentTypeProductOfferPostCreatePlugin(), + ]; + } + + /** + * @return array<\Spryker\Zed\ProductOfferExtension\Dependency\Plugin\ProductOfferPostUpdatePluginInterface> + */ + protected function getProductOfferPostUpdatePlugins(): array + { + return [ + new ShipmentTypeProductOfferPostUpdatePlugin(), + ]; + } + + /** + * @return array<\Spryker\Zed\ProductOfferExtension\Dependency\Plugin\ProductOfferExpanderPluginInterface> + */ + protected function getProductOfferExpanderPlugins(): array + { + return [ + new ShipmentTypeProductOfferExpanderPlugin(), + ]; + } +``` + +**src/Pyz/Client/ProductOfferStorage/ProductOfferStorageDependencyProvider.php** + +```php + + */ + protected function getProductOfferStorageExpanderPlugins(): array + { + return [ + new ShipmentTypeProductOfferStorageExpanderPlugin(), + ]; + } +} +``` diff --git a/_includes/pbc/all/install-features/202304.0/marketplace/install-the-marketplace-product-offer-feature.md b/_includes/pbc/all/install-features/202304.0/marketplace/install-the-marketplace-product-offer-feature.md new file mode 100644 index 00000000000..665493dbf78 --- /dev/null +++ b/_includes/pbc/all/install-features/202304.0/marketplace/install-the-marketplace-product-offer-feature.md @@ -0,0 +1,1815 @@ + + +This document describes how to integrate the [Marketplace Product Offer](/docs/pbc/all/offer-management/{{page.version}}/marketplace/marketplace-product-offer-feature-overview.html) into a Spryker project. + +## Install feature core + +Follow the steps below to install the Marketplace Product Offer feature core. + +### Prerequisites + +To start feature integration, integrate the required features: + +| NAME | VERSION | INTEGRATION GUIDE | +|----------------------|------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Spryker Core | {{page.version}} | [Spryker Core feature integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/spryker-core-feature-integration.html) | +| Marketplace Merchant | {{page.version}} | [Marketplace Merchant feature integration](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-feature.html) | +| Product | {{page.version}} | [Product feature integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/product-feature-integration.html) | + +### 1) Install the required modules using Composer + +```bash +composer require spryker-feature/marketplace-product-offer:"{{page.version}}" --update-with-dependencies +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following modules were installed: + +| MODULE | EXPECTED DIRECTORY | +|--------------------------------------|--------------------------------------------------| +| MerchantProductOffer | spryker/merchant-product-offer | +| MerchantProductOfferDataImport | spryker/merchant-product-offer-data-import | +| MerchantProductOfferGui | spryker/merchant-product-offer-gui | +| MerchantProductOfferSearch | spryker/merchant-product-offer-search | +| MerchantProductOfferStorage | spryker/merchant-product-offer-storage | +| MerchantProductOfferStorageExtension | spryker/merchant-product-offer-storage-extension | +| ProductOffer | spryker/product-offer | +| ProductOfferExtension | spryker/product-offer-extension | +| ProductOfferGui | spryker/product-offer-gui | +| ProductOfferGuiExtension | spryker/product-offer-gui-extension | +| ProductOfferStorage | spryker/product-offer-storage | +| ProductOfferStorageExtension | spryker/product-offer-storage-extension | +| ProductOfferValidity | spryker/product-offer-validity | +| ProductOfferValidityDataImport | spryker/product-offer-validity-data-import | +| ProductOfferValidityGui | spryker/product-offer-validity-gui | + +{% endinfo_block %} + +### 2) Set up database schema and transfer objects + +1. Adjust the schema definition so that entity changes will trigger events: + +| AFFECTED ENTITY | TRIGGERED EVENTS | +|-------------------------|-------------------------------------------------------------------------------------------------------------------------| +| spy_product_offer | Entity.spy_product_offer.create
Entity.spy_product_offer.update
Entity.spy_product_offer.delete | +| spy_product_offer_store | Entity.spy_product_offer_store.create
Entity.spy_product_offer_store.update
Entity.spy_product_offer_store.delete | + + +**src/Pyz/Zed/ProductOffer/Persistence/Propel/Schema/spy_product_offer.schema.xml** + +```xml + + + + + + + + + + +
+ + + + + +
+ +``` + +2. Apply database changes and to generate entity and transfer changes: + +```bash +console transfer:generate +console propel:install +``` + +{% info_block warningBox "Verification" %} + +Verify that the following changes have been implemented by checking your database: + +| DATABASE ENTITY | TYPE | EVENT | +|---------------------------------------------|-------|---------| +| spy_product_concrete_product_offers_storage | table | created | +| spy_product_offer | table | created | +| spy_product_offer_storage | table | created | +| spy_product_offer_store | table | created | +| spy_product_offer_validity | table | created | + +Make sure that the following changes were applied in transfer objects: + +| TRANSFER | TYPE | EVENT | PATH | +|--------------------------------------------|----------|---------|----------------------------------------------------------------------| +| Item.productOfferReference | property | created | src/Generated/Shared/Transfer/ItemTransfer | +| MerchantProductOfferCriteria | class | created | src/Generated/Shared/Transfer/MerchantProductOfferCriteriaTransfer | +| PageMap.merchantReferences | property | created | src/Generated/Shared/Transfer/PageMapTransfer | +| ProductAbstractMerchant.merchantReferences | property | created | src/Generated/Shared/Transfer/ProductAbstractMerchantTransfer | +| ProductOffer | class | created | src/Generated/Shared/Transfer/ProductOfferTransfer | +| ProductOfferCollection | class | created | src/Generated/Shared/Transfer/ProductOfferCollectionTransfer | +| ProductOfferCriteria | class | created | src/Generated/Shared/Transfer/ProductOfferCriteriaTransfer | +| ProductOfferError | class | created | src/Generated/Shared/Transfer/ProductOfferErrorTransfer | +| ProductOfferResponse | class | created | src/Generated/Shared/Transfer/ProductOfferResponseTransfer | +| ProductOfferStorage | class | created | src/Generated/Shared/Transfer/ProductOfferStorageTransfer | +| ProductOfferStorageCollection | class | created | src/Generated/Shared/Transfer/ProductOfferStorageCollectionTransfer | +| ProductOfferStorageCriteria | class | created | src/Generated/Shared/Transfer/ProductOfferStorageCriteriaTransfer | +| ProductOfferStore | class | created | src/Generated/Shared/Transfer/ProductOfferStoreTransfer | +| ProductOfferValidity | class | created | src/Generated/Shared/Transfer/ProductOfferValidityTransfer | +| ProductOfferValidityCollection | class | created | src/Generated/Shared/Transfer/ProductOfferValidityCollectionTransfer | +| EventEntity | class | created | src/Generated/Shared/Transfer/EventEntityTransfer | +| ProductConcretePageSearch | class | created | src/Generated/Shared/Transfer/ProductConcretePageSearchTransfer | +| ProductPageSearch.merchantReferences | property | created | src/Generated/Shared/Transfer/ProductPageSearchTransfer | +| ProductPayload.merchantReferences | property | created | src/Generated/Shared/Transfer/ProductPayloadTransfer | +| ProductStorageCriteria.merchantReference | property | created | src/Generated/Shared/Transfer/ProductStorageCriteriaTransfer | +| ProductView.productOfferReference | property | created | src/Generated/Shared/Transfer/ProductViewTransfer | +| Merchant.merchantReference | property | created | src/Generated/Shared/Transfer/MerchantTransfer | +| Merchant.status | property | created | src/Generated/Shared/Transfer/MerchantTransfer | + +{% endinfo_block %} + +### 3) Add translations + +Generate a new translation cache for Zed: + +```bash +console translator:generate-cache +``` + +### 4) Configure export to Redis and Elasticsearch + +To configure export to Redis and Elasticsearch, take the following steps: + +#### Set up publisher plugins + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|---------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------|----------------------------------------------------------------------------------------------------| +| ProductConcreteProductOffersDeletePublisherPlugin | Finds and deletes product concrete offer storage entities by the given concreteSkus. | | Spryker\Zed\ProductOfferStorage\Communication\Plugin\Publisher\ProductConcreteOffers | +| ProductConcreteProductOffersWritePublisherPlugin | Queries all active product offer with the given concreteSkus, stores data as JSON encoded to storage table. | | Spryker\Zed\ProductOfferStorage\Communication\Plugin\Publisher\ProductConcreteOffers | +| ProductConcreteProductOffersStoreWritePublisherPlugin | Publishes product concrete product offers using product offer IDs retrieved from event transfers. | | Spryker\Zed\ProductOfferStorage\Communication\Plugin\Publisher\ProductConcreteOffers | +| ProductConcreteProductOffersStoreDeletePublisherPlugin | Unpublishes product offer reference from `spy_product_concrete_product_offers_storage` by provided `EventEntity.foreign_keys.fk_product_offer` and `EventEntity.foreign_keys.fk_store` transfer properties. | | Spryker\Zed\ProductOfferStorage\Communication\Plugin\Publisher\ProductConcreteOffers | +| ProductOfferDeletePublisherPlugin | Finds and deletes product offer storage entities with the given `productOfferReferences` and sends a delete message to the queue based on module config. | | Spryker\Zed\ProductOfferStorage\Communication\Plugin\Publisher\ProductOffer | +| ProductOfferWritePublisherPlugin | Queries all active product offer with the given productOfferReferences, stores data as JSON encoded to storage table. | | Spryker\Zed\ProductOfferStorage\Communication\Plugin\Publisher\ProductOffer | +| ProductOfferStoreWritePublisherPlugin | Publishes product offers using product offer IDs retrieved from event transfers. | | Spryker\Zed\ProductOfferStorage\Communication\Plugin\Publisher\ProductOffer | +| ProductOfferStoreDeletePublisherPlugin | Unpublishes product offers by provided `EventEntity.foreign_keys.fk_product_offer` and `EventEntity.foreign_keys.fk_store` transfer properties. | | Spryker\Zed\ProductOfferStorage\Communication\Plugin\Publisher\ProductOffer | +| ProductOfferPublisherTriggerPlugin | Publishes the product offer collection by offset and limit from Persistence. | | Spryker\Zed\ProductOfferStorage\Communication\Plugin\Publisher | +| MerchantProductConcreteProductOfferWritePublisherPlugin | Retrieves all active product offers by `merchantIds`, publish active product offers data to `ProductConcreteProductOffersStorage`. | | Spryker\Zed\MerchantProductOfferStorage\Communication\Plugin\Publisher\ProductConcreteProductOffer | +| MerchantProductOfferWritePublisherPlugin | Queries all active product offer with the given merchantIds, stores data as JSON encoded to storage table. | | Spryker\Zed\MerchantProductOfferStorage\Communication\Plugin\Publisher\Merchant | +| ProductConcreteWritePublisherPlugin | Publishes concrete products by create, update, and delete product offer events. | | Spryker\Zed\MerchantProductOfferSearch\Communication\Plugin\Publisher\ProductOffer | +| ProductConcreteWritePublisherPlugin | Publishes concrete products by create, update, and delete product offer store events. | | Spryker\Zed\MerchantProductOfferSearch\Communication\Plugin\Publisher\ProductOfferStore | +| MerchantProductOfferProductConcreteExpanderPlugin | Expands product concrete collection with offers. | | \Spryker\Zed\MerchantProductOffer\Communication\Plugin\Product | + +
src/Pyz/Zed/Publisher/PublisherDependencyProvider.php + +```php +|array> + */ + protected function getPublisherPlugins(): array + { + return array_merge( + $this->getProductOfferStoragePlugins(), + $this->getMerchantProductOfferStoragePlugins(), + $this->getMerchantProductOfferSearchPlugins(), + ); + } + + /** + * @return list<\Spryker\Zed\PublisherExtension\Dependency\Plugin\PublisherPluginInterface> + */ + protected function getProductOfferStoragePlugins(): array + { + return [ + new ProductConcreteProductOffersDeletePublisherPlugin(), + new ProductConcreteProductOffersWritePublisherPlugin(), + new ProductOfferDeletePublisherPlugin(), + new ProductOfferWritePublisherPlugin(), + new ProductOfferStoreWritePublisherPlugin(), + new ProductOfferStoreDeletePublisherPlugin(), + new ProductConcreteProductOffersStoreWritePublisherPlugin(), + new ProductConcreteProductOffersStoreDeletePublisherPlugin(), + ]; + } + + /** + * @return list<\Spryker\Zed\PublisherExtension\Dependency\Plugin\PublisherPluginInterface> + */ + protected function getMerchantProductOfferStoragePlugins(): array + { + return [ + new MerchantProductConcreteProductOfferWritePublisherPlugin(), + new MerchantProductOfferWritePublisherPlugin(), + ]; + } + + /** + * @return list<\Spryker\Zed\PublisherExtension\Dependency\Plugin\PublisherPluginInterface> + */ + protected function getMerchantProductOfferSearchPlugins(): array + { + return [ + new ProductOfferProductConcreteWritePublisherPlugin(), + new ProductOfferStoreProductConcreteWritePublisherPlugin(), + ]; + } + + /** + * @return array<\Spryker\Zed\PublisherExtension\Dependency\Plugin\PublisherTriggerPluginInterface> + */ + protected function getPublisherTriggerPlugins(): array + { + return [ + new ProductOfferPublisherTriggerPlugin(), + ]; + } +} +``` +
+ +#### Set up event listeners + +1. Set up the following plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|-------------------------------------------|------------------------------------------------------------------------------------------|---------------|------------------------------------------------------------------------------| +| MerchantProductOfferSearchEventSubscriber | Registers listeners responsible for publishing merchant product offer search to storage. | | Spryker\Zed\MerchantProductOfferSearch\Communication\Plugin\Event\Subscriber | +| MerchantSearchEventSubscriber | Registers listeners responsible for publishing merchant search to storage. | | Spryker\Zed\MerchantProductOfferSearch\Communication\Plugin\Event\Subscriber | + +**src/Pyz/Zed/Event/EventDependencyProvider.php** + +```php +add(new MerchantSearchEventSubscriber()); + $eventSubscriberCollection->add(new MerchantProductOfferSearchEventSubscriber()); + + return $eventSubscriberCollection; + } +} +``` + +2. Register the synchronization queue and synchronization error queue: + +**src/Pyz/Client/RabbitMq/RabbitMqConfig.php** + +```php + + */ + protected function getSynchronizationQueueConfiguration(): array + { + return [ + ProductOfferStorageConfig::PRODUCT_OFFER_SYNC_STORAGE_QUEUE, + ]; + } + +} +``` + +#### Configure message processors + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|---------------------------------------------------|------------------------------------------------------------------------------------------------------------------|---------------|--------------------------------------------------------| +| SynchronizationStorageQueueMessageProcessorPlugin | Configures all merchant product offers to sync with Redis storage and marks messages as failed in case of error. | | Spryker\Zed\Synchronization\Communication\Plugin\Queue | + +**src/Pyz/Zed/Queue/QueueDependencyProvider.php** + +```php + + */ + protected function getProcessorMessagePlugins(Container $container): array + { + return [ + ProductOfferStorageConfig::PRODUCT_OFFER_SYNC_STORAGE_QUEUE => new SynchronizationStorageQueueMessageProcessorPlugin(), + ]; + } +} +``` + +#### Set up, regenerate, and resync features + +1. Set up the following plugins: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|---------------------------------------------------------------------|---------------------------------------------------------------------|---------------|----------------------------------------------------------------------| +| ProductConcreteProductOffersSynchronizationDataBulkRepositoryPlugin | Allows synchronizing the entire storage table content into Storage. | | Spryker\Zed\ProductOfferStorage\Communication\Plugin\Synchronization | +| ProductOfferSynchronizationDataBulkRepositoryPlugin | Allows synchronizing the entire storage table content into Storage. | | Spryker\Zed\ProductOfferStorage\Communication\Plugin\Synchronization | + +**src/Pyz/Zed/Synchronization/SynchronizationDependencyProvider.php** + +```php + + */ + protected function getSynchronizationDataPlugins(): array + { + return [ + new ProductConcreteProductOffersSynchronizationDataBulkRepositoryPlugin(), + new ProductOfferSynchronizationDataBulkRepositoryPlugin(), + ]; + } +} +``` + +2. Configure synchronization storage: + +**src/Pyz/Zed/ProductOfferStorage/ProductOfferStorageConfig.php** + +```php + + */ + protected function getProductConcreteExpanderPlugins(): array + { + return [ + new MerchantProductOfferProductConcreteExpanderPlugin(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +Make sure that after setting up the event listeners, the following commands do the following: + +* `console sync:data product_concrete_product_offers` exports data from the `spy_product_concrete_product_offers_storage` table to Redis. +* `console sync:data product_offer` exports data from the `spy_product_offer_storage` table to Redis. + +Make sure that when the following entities get updated through the ORM, the corresponding Redis keys have the correct values. + +| TARGET ENTITY | EXAMPLE EXPECTED DATA IDENTIFIER | EXAMPLE EXPECTED DATA FRAGMENT | +|---------------|-------------------------------------------------|----------------------------------------------------------------------------------------------------------| +| ProductOffer | kv:product_offer:offer2 | {“id_product_offer”:1,“id_merchant”:6,“product_offer_reference”:“offer1",“merchant_sku”:“GS952M00H-Q11"} | +| ProductOffer | kv:product_concrete_product_offers:093_24495843 | [“offer3”,“offer4"] | + +{% endinfo_block %} + +### 5) Import data + +1. Prepare your data according to your requirements using the demo data: + +
data/import/common/common/marketplace/merchant_product_offer.csv + +```csv +product_offer_reference,concrete_sku,merchant_reference,merchant_sku,is_active,approval_status +offer1,093_24495843,MER000001,GS952M00H-Q11,1,approved +offer2,090_24495844,MER000002,,1,approved +offer3,091_25873091,MER000001,M9122A0AQ-C11,1,approved +offer4,091_25873091,MER000002,M9122A0AQ-C11,1,approved +offer5,092_24495842,MER000001,TH344E01G-Q11,0,approved +offer6,092_24495842,MER000002,OB054P005-Q11,1,approved +offer7,193_32124735,MER000001,,1,approved +offer8,001_25904006,MER000002,,1,approved +offer9,002_25904004,MER000002,,0,approved +offer10,003_26138343,MER000002,,0,waiting_for_approval +offer11,004_30663302,MER000002,,1,waiting_for_approval +offer12,005_30663301,MER000002,,1,approved +offer13,006_30692993,MER000002,,1,approved +offer14,007_30691822,MER000002,,1,approved +offer15,008_30692992,MER000002,,1,approved +offer16,009_30692991,MER000002,,1,approved +offer17,010_30692994,MER000002,,1,approved +offer18,011_30775359,MER000002,,1,approved +offer19,012_25904598,MER000002,,1,approved +offer20,013_25904584,MER000002,,1,approved +offer21,014_25919241,MER000002,,1,approved +offer22,015_25904009,MER000002,,1,approved +offer23,016_21748907,MER000002,,1,approved +offer24,017_21748906,MER000002,,1,approved +offer25,018_21081477,MER000002,,1,approved +offer26,019_21081473,MER000002,,1,approved +offer27,020_21081478,MER000002,,1,approved +offer28,021_21081475,MER000002,,1,approved +offer29,022_21994751,MER000002,,1,approved +offer30,023_21758366,MER000002,,1,approved +offer31,024_21987578,MER000002,,1,approved +offer32,025_21764665,MER000002,,1,approved +offer33,026_21748904,MER000002,,1,approved +offer34,027_26976107,MER000002,,1,approved +offer35,028_26976108,MER000002,,1,approved +offer36,029_26976109,MER000002,,1,approved +offer37,030_30021698,MER000002,,1,approved +offer38,031_30021637,MER000002,,1,approved +offer39,032_32125551,MER000002,,1,approved +offer40,033_32125568,MER000002,,1,approved +offer41,034_32125390,MER000002,,1,approved +offer42,035_17360369,MER000002,,1,approved +offer43,036_17360368,MER000002,,1,approved +offer44,037_25904011,MER000002,,1,approved +offer45,038_25905593,MER000002,,1,approved +offer46,039_25904010,MER000002,,1,approved +offer47,040_25904665,MER000002,,1,approved +offer48,041_25904691,MER000002,,1,approved +offer49,001_25904006,MER000005,,1,approved +offer50,002_25904004,MER000005,,1,approved +offer51,003_26138343,MER000005,,0,approved +offer52,004_30663302,MER000005,,1,approved +offer53,005_30663301,MER000005,,0,approved +offer54,006_30692993,MER000005,,1,approved +offer55,007_30691822,MER000005,,1,waiting_for_approval +offer56,008_30692992,MER000005,,1,waiting_for_approval +offer57,009_30692991,MER000005,,1,approved +offer58,010_30692994,MER000005,,1,approved +offer59,011_30775359,MER000005,,1,approved +offer60,012_25904598,MER000005,,1,approved +offer61,013_25904584,MER000005,,1,approved +offer62,014_25919241,MER000005,,1,approved +offer63,015_25904009,MER000005,,1,approved +offer64,016_21748907,MER000005,,1,approved +offer65,017_21748906,MER000005,,1,approved +offer66,018_21081477,MER000005,,1,approved +offer67,019_21081473,MER000005,,1,approved +offer68,020_21081478,MER000005,,1,approved +offer69,021_21081475,MER000005,,1,approved +offer70,022_21994751,MER000005,,1,approved +offer71,023_21758366,MER000005,,1,approved +offer72,024_21987578,MER000005,,1,approved +offer73,025_21764665,MER000005,,1,approved +offer74,026_21748904,MER000005,,1,approved +offer75,027_26976107,MER000005,,1,approved +offer76,028_26976108,MER000005,,1,approved +offer77,029_26976109,MER000005,,1,approved +offer78,030_30021698,MER000005,,1,approved +offer79,031_30021637,MER000005,,1,approved +offer80,032_32125551,MER000005,,1,approved +offer81,033_32125568,MER000005,,1,approved +offer82,034_32125390,MER000005,,1,approved +offer83,035_17360369,MER000005,,1,approved +offer84,036_17360368,MER000005,,1,approved +offer85,037_25904011,MER000005,,1,approved +offer86,038_25905593,MER000005,,1,approved +offer87,039_25904010,MER000005,,1,approved +offer88,040_25904665,MER000005,,1,approved +offer89,041_25904691,MER000005,,1,approved +offer90,016_21748907,MER000006,,1,approved +offer91,017_21748906,MER000006,,1,waiting_for_approval +offer92,018_21081477,MER000006,,1,approved +offer93,019_21081473,MER000006,,0,approved +offer94,020_21081478,MER000006,,1,approved +offer95,021_21081475,MER000006,,1,approved +offer96,022_21994751,MER000006,,1,approved +offer97,023_21758366,MER000006,,1,approved +offer98,024_21987578,MER000006,,1,approved +offer99,025_21764665,MER000006,,1,approved +offer100,026_21748904,MER000006,,0,approved +offer101,027_26976107,MER000006,,1,approved +offer102,028_26976108,MER000006,,1,approved +offer103,029_26976109,MER000006,,1,waiting_for_approval +offer169,076_24394207,MER000006,,1,approved +offer170,077_24584210,MER000006,,1,approved +offer171,078_24602396,MER000006,,1,approved +offer172,079_24394211,MER000006,,1,approved +offer173,080_24394206,MER000006,,1,approved +offer348,193_32124735,MER000006,,1,approved +offer349,194_25904145,MER000006,,1,approved +offer350,195_25904159,MER000006,,1,approved +offer351,196_23120327,MER000006,,1,approved +offer352,197_21421718,MER000006,,1,approved +offer353,198_19692589,MER000006,,1,approved +offer354,199_7016823,MER000006,,1,approved +offer355,199_24788780,MER000006,,1,approved +offer356,200_5787536,MER000006,,1,approved +offer357,201_11217755,MER000006,,1,approved +offer358,202_5782479,MER000006,,1,approved +offer359,203_15619960,MER000006,,1,approved +offer360,204_29851280,MER000006,,1,approved +offer402,101_29727910,MER000004,,1,approved +offer403,102_30727008,MER000005,,0,approved +offer404,102_30727008,MER000005,,1,denied +offer405,102_30727008,MER000005,,1,waiting_for_approval +offer410,104_30727010,MER000005,,1,approved +offer411,113_29885591,MER000005,,1,approved +offer412,113_29885591,MER000002,,1,approved +offer413,118_29804739,MER000005,,1,approved +offer414,118_29804739,MER000002,,1,approved +offer415,112_312526171,MER000005,,1,approved +offer416,112_306918001,MER000002,,1,approved +offer417,112_312526191,MER000005,,1,approved +offer418,112_312526172,MER000002,,1,approved +``` +
+ +| COLUMN | REQUIRED | DATA TYPE | DATA EXAMPLE | DATA EXPLANATION | +|-------------------------|----------|-----------|---------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| product_offer_reference | ✓ | string | offer1 | Product offer identifier that references to this merchant. | +| concrete_sku | ✓ | string | 093_24495843 | Concrete product SKU this product offer is attached to. | +| merchant_reference | ✓ | string | MER000002 | Merchant identifier. | +| merchant_sku | | string | GS952M00H-Q11 | Merchant internal SKU for the product offer. | +| is_active | | boolean | 1 | Product offer status, defaults to 1. | +| approval_status | | string | approved | (*Waiting for Approval* > *Approved* > *Denied*). *Denied* and *Waiting for Approval* statuses mean that the offer is not visible on PDP regardless of Product Offer → Active = true. This can be configured (along with the transition between statuses in `ProductOfferConfig`). If not supplied, `ProductOfferConfig` > `getDefaultStatus` is applied. | + +
data/import/common/common/marketplace/merchant_product_offer_store.csv + +```csv +product_offer_reference,store_name +offer1,DE +offer2,DE +offer3,DE +offer4,DE +offer6,DE +offer7,DE +offer8,DE +offer9,DE +offer10,DE +offer11,DE +offer12,DE +offer13,DE +offer14,DE +offer15,DE +offer16,DE +offer17,DE +offer18,DE +offer19,DE +offer20,DE +offer21,DE +offer22,DE +offer23,DE +offer24,DE +offer25,DE +offer26,DE +offer27,DE +offer28,DE +offer29,DE +offer30,DE +offer31,DE +offer32,DE +offer33,DE +offer34,DE +offer35,DE +offer36,DE +offer37,DE +offer38,DE +offer39,DE +offer40,DE +offer41,DE +offer42,DE +offer43,DE +offer44,DE +offer45,DE +offer46,DE +offer47,DE +offer48,DE +offer49,DE +offer50,DE +offer51,DE +offer52,DE +offer53,DE +offer54,DE +offer55,DE +offer56,DE +offer57,DE +offer58,DE +offer59,DE +offer60,DE +offer61,DE +offer62,DE +offer63,DE +offer64,DE +offer65,DE +offer66,DE +offer67,DE +offer68,DE +offer69,DE +offer70,DE +offer71,DE +offer72,DE +offer73,DE +offer74,DE +offer75,DE +offer76,DE +offer77,DE +offer78,DE +offer79,DE +offer80,DE +offer81,DE +offer82,DE +offer83,DE +offer84,DE +offer85,DE +offer86,DE +offer87,DE +offer88,DE +offer89,DE +offer90,DE +offer91,DE +offer92,DE +offer93,DE +offer94,DE +offer95,DE +offer96,DE +offer97,DE +offer98,DE +offer99,DE +offer100,DE +offer101,DE +offer102,DE +offer103,DE +offer169,DE +offer170,DE +offer171,DE +offer172,DE +offer173,DE +offer348,DE +offer349,DE +offer350,DE +offer351,DE +offer352,DE +offer353,DE +offer354,DE +offer355,DE +offer356,DE +offer357,DE +offer358,DE +offer359,DE +offer360,DE +offer402,DE +offer403,DE +offer404,DE +offer405,DE +offer410,DE +offer411,DE +offer412,DE +offer413,DE +offer414,DE +offer415,DE +offer416,DE +offer417,DE +offer418,DE +offer2,US +offer4,US +offer6,US +offer7,US +offer8,US +offer9,US +offer10,US +offer11,US +offer12,US +offer13,US +offer14,US +offer15,US +offer16,US +offer17,US +offer18,US +offer19,US +offer20,US +offer21,US +offer22,US +offer23,US +offer24,US +offer25,US +offer26,US +offer27,US +offer28,US +offer29,US +offer30,US +offer31,US +offer32,US +offer33,US +offer34,US +offer35,US +offer36,US +offer37,US +offer38,US +offer39,US +offer40,US +offer41,US +offer42,US +offer43,US +offer44,US +offer45,US +offer46,US +offer47,US +offer48,US +offer49,US +offer50,US +offer51,US +offer52,US +offer53,US +offer54,US +offer55,US +offer56,US +offer57,US +offer58,US +offer59,US +offer60,US +offer61,US +offer62,US +offer63,US +offer64,US +offer65,US +offer66,US +offer67,US +offer68,US +offer69,US +offer70,US +offer71,US +offer72,US +offer73,US +offer74,US +offer75,US +offer76,US +offer77,US +offer78,US +offer79,US +offer80,US +offer81,US +offer82,US +offer83,US +offer84,US +offer85,US +offer86,US +offer87,US +offer88,US +offer89,US +offer90,US +offer91,US +offer92,US +offer93,US +offer94,US +offer95,US +offer96,US +offer97,US +offer98,US +offer99,US +offer100,US +offer101,US +offer102,US +offer103,US +offer169,US +offer170,US +offer171,US +offer172,US +offer173,US +offer348,US +offer349,US +offer350,US +offer351,US +offer352,US +offer353,US +offer354,US +offer355,US +offer356,US +offer357,US +offer358,US +offer359,US +offer360,US +offer1,AT +offer2,AT +offer3,AT +offer4,AT +offer6,AT +offer7,AT +offer8,AT +offer9,AT +offer10,AT +offer11,AT +offer12,AT +offer13,AT +offer14,AT +offer15,AT +offer16,AT +offer17,AT +offer18,AT +offer19,AT +offer20,AT +offer21,AT +offer22,AT +offer23,AT +offer24,AT +offer25,AT +offer26,AT +offer27,AT +offer28,AT +offer29,AT +offer30,AT +offer31,AT +offer32,AT +offer33,AT +offer34,AT +offer35,AT +offer36,AT +offer37,AT +offer38,AT +offer39,AT +offer40,AT +offer41,AT +offer42,AT +offer43,AT +offer44,AT +offer45,AT +offer46,AT +offer47,AT +offer48,AT +offer49,AT +offer50,AT +offer51,AT +offer52,AT +offer53,AT +offer54,AT +offer55,AT +offer56,AT +offer57,AT +offer58,AT +offer59,AT +offer60,AT +offer61,AT +offer62,AT +offer63,AT +offer64,AT +offer65,AT +offer66,AT +offer67,AT +offer68,AT +offer69,AT +offer70,AT +offer71,AT +offer72,AT +offer73,AT +offer74,AT +offer75,AT +offer76,AT +offer77,AT +offer78,AT +offer79,AT +offer80,AT +offer81,AT +offer82,AT +offer83,AT +offer84,AT +offer85,AT +offer86,AT +offer87,AT +offer88,AT +offer89,AT +offer90,AT +offer91,AT +offer92,AT +offer93,AT +offer94,AT +offer95,AT +offer96,AT +offer97,AT +offer98,AT +offer99,AT +offer100,AT +offer101,AT +offer102,AT +offer103,AT +offer169,AT +offer170,AT +offer171,AT +offer172,AT +offer173,AT +offer348,AT +offer349,AT +offer350,AT +offer351,AT +offer352,AT +offer353,AT +offer354,AT +offer355,AT +offer356,AT +offer357,AT +offer358,AT +offer359,AT +offer360,AT +offer402,AT +offer403,AT +offer404,AT +offer405,AT +offer410,AT +offer411,AT +offer412,AT +offer413,AT +offer414,AT +offer415,AT +offer416,AT +offer417,AT +offer418,AT +``` +
+ +| COLUMN | REQUIRED | DATA TYPE | DATA EXAMPLE | DATA EXPLANATION | +|-------------------------|----------|-----------|--------------|-------------------------------------------------------| +| product_offer_reference | ✓ | string | offer1 | Product Offer reference, unique identifier per Offer. | +| store_name | ✓ | string | DE | The name of the store. | + +**data/import/common/common/marketplace/product_offer_validity.csv** + +``` +product_offer_reference,valid_from,valid_to +offer1,,2020-01-20 00:00:00.000000 +offer2,,2020-01-20 00:00:00.000000 +offer3,,2020-01-20 00:00:00.000000 +offer4,,2020-01-20 00:00:00.000000 +offer5,2030-01-01 00:00:00.000000, +offer6,2030-01-01 00:00:00.000000, +offer7,2030-01-01 00:00:00.000000, +offer8,2030-01-01 00:00:00.000000, +offer9,2020-07-01 00:00:00.000000,2025-12-01 00:00:00.000000 +offer10,2020-07-01 00:00:00.000000,2025-12-01 00:00:00.000000 +offer49,,2020-01-20 00:00:00.000000 +offer50,,2020-01-20 00:00:00.000000 +offer51,2030-01-01 00:00:00.000000, +offer52,2030-01-01 00:00:00.000000, +offer53,2020-07-01 00:00:00.000000,2025-12-01 00:00:00.000000 +offer54,2020-07-01 00:00:00.000000,2025-12-01 00:00:00.000000 +offer90,,2020-01-20 00:00:00.000000 +offer91,,2020-01-20 00:00:00.000000 +offer92,2030-01-01 00:00:00.000000, +offer93,2030-01-01 00:00:00.000000, +offer94,2020-07-01 00:00:00.000000,2025-12-01 00:00:00.000000 +offer95,2020-07-01 00:00:00.000000,2025-12-01 00:00:00.000000 +``` + +| COLUMN | REQUIRED | DATA TYPE | DATA EXAMPLE | DATA EXPLANATION | +|-------------------------|----------|-----------|--------------|----------------------------------------------| +| product_offer_reference | ✓ | string | offer1 | Unique product offer identifier. | +| valid_from | | String | 2020-01-01 | Date since which the product offer is valid. | +| valid_to | | String | 2020-01-01 | Date till which the product offer is valid. | + +2. Register the following plugins to enable data import: + +| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | +|-------------------------------------------|---------------------------------------------------|---------------|----------------------------------------------------------------------------| +| MerchantProductOfferDataImportPlugin | Imports merchant product offer data. | | Spryker\Zed\MerchantProductOfferDataImport\Communication\Plugin\DataImport | +| MerchantProductOfferStoreDataImportPlugin | Imports the product offer to store relation data. | | Spryker\Zed\MerchantProductOfferDataImport\Communication\Plugin\DataImport | +| ProductOfferValidityDataImportPlugin | Imports product offer validity data. | | Spryker\Zed\ProductOfferValidityDataImport\Communication\DataImport | + +**src/Pyz/Zed/DataImport/DataImportDependencyProvider.php** + +```php + + */ + protected function getDataImporterPlugins(): array + { + return [ + new MerchantProductOfferDataImportPlugin(), + new MerchantProductOfferStoreDataImportPlugin(), + new ProductOfferValidityDataImportPlugin(), + ]; + } +} +``` + +**data/import/local/full_EU.yml** + +```yml +version: 0 + +actions: + - data_entity: merchant-product-offer + source: data/import/common/common/marketplace/merchant_product_offer.csv + - data_entity: merchant-product-offer-store + source: data/import/common/DE/merchant_product_offer_store.csv + - data_entity: merchant-product-offer-store + source: data/import/common/AT/merchant_product_offer_store.csv + - data_entity: product-offer-validity + source: data/import/common/common/marketplace/product_offer_validity.csv +``` + +**data/import/local/full_US.yml** + +```yml +version: 0 + +actions: + - data_entity: merchant-product-offer + source: data/import/common/common/marketplace/merchant_product_offer.csv + - data_entity: merchant-product-offer-store + source: data/import/common/US/merchant_product_offer_store.csv + - data_entity: product-offer-validity + source: data/import/common/common/marketplace/product_offer_validity.csv +``` + +Import data: + +```bash +console data:import merchant-product-offer +console data:import merchant-product-offer-store +console data:import product-offer-validity +``` + +{% info_block warningBox "Verification" %} + +Make sure the following is true: +* The product offer data is attached to Merchants in `spy_product_offer` and to Stores in `spy_product_offer_store`. +* The product offer validity data is imported to `spy_product_offer_validity` correctly. + +{% endinfo_block %} + +### 6) Set up behavior + +Enable the following behaviors by registering the plugins: + +| PLUGIN | DESCRIPTION | PREREQUISITES | NAMESPACE | +|----------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------| +| MerchantProductOfferTableExpanderPlugin | Expands the `ProductOfferGui` product table with merchant data. | | Spryker\Zed\MerchantProductOfferGui\Communication\Plugin | +| MerchantProductOfferViewSectionPlugin | Adds a new merchant section to the `ProductOfferGui` view. | | Spryker\Zed\MerchantProductOfferGui\Communication\Plugin\ProductOfferGui | +| ProductOfferValidityProductOfferViewSectionPlugin | Adds a new validity section to the `ProductOfferGui` view. | | Spryker\Zed\ProductOfferValidityGui\Communication\Plugin\ProductOfferGui | +| MerchantProductOfferListActionViewDataExpanderPlugin | Expands product offer view data with merchant data when showing it in the `ProductOfferGui` module. | | Spryker\Zed\MerchantGui\Communication\Plugin\ProductOffer | +| MerchantReferenceQueryExpanderPlugin | Adds filter by the merchant reference to the search query. | | Spryker\Client\MerchantProductOfferSearch\Plugin\Search | +| MerchantNameSearchConfigExpanderPlugin | Expands facet configuration with the merchant name filter. | | Spryker\Client\MerchantProductOfferSearch\Plugin\Search | +| MerchantProductPageDataExpanderPlugin | Expands the provided `ProductAbstractPageSearch` transfer object's data by merchant names. | | Spryker\Zed\MerchantProductOfferSearch\Communication\Plugin\ProductPageSearch | +| MerchantProductPageDataLoaderPlugin | Expands the `ProductPageLoadTransfer` object with merchant data. | | Spryker\Zed\MerchantProductOfferSearch\Communication\Plugin\ProductPageSearch | +| MerchantNamesProductAbstractMapExpanderPlugin | Adds merchant names to product abstract search data. | | Spryker\Zed\MerchantProductOfferSearch\Communication\Plugin\ProductPageSearch | +| MerchantReferencesProductAbstractsMapExpanderPlugin | Adds merchant references to product abstract search data. | | Spryker\Zed\MerchantProductOfferSearch\Communication\Plugin\ProductPageSearch | +| DefaultProductOfferReferenceStrategyPlugin | Sets the default selected product offer in PDP for a concrete product. It selects the first product offer in the list. | ProductViewProductOfferExpanderPlugin | Spryker\Client\ProductOfferStorage\Plugin\ProductOfferStorage | +| ProductOfferReferenceStrategyPlugin | Sets selected product offer in `ProductConcreteTransfer` if one is already selected on PDP. | ProductViewProductOfferExpanderPlugin | Spryker\Client\ProductOfferStorage\Plugin\ProductOfferStorage | +| ProductViewProductOfferExpanderPlugin | Adds product offer data to `ProductViewTransfer` when a retrieving product. | | Spryker\Client\ProductOfferStorage\Plugin\ProductStorage | +| ProductOfferValidityProductOfferPostCreatePlugin | Creates product offer validity dates after the product offer is created. | | Spryker\Zed\ProductOfferValidity\Communication\Plugin\ProductOffer | +| ProductOfferValidityProductOfferPostUpdatePlugin | Updates product offer validity dates after the product offer is updated. | | Spryker\Zed\ProductOfferValidity\Communication\Plugin\ProductOffer | +| ProductOfferValidityProductOfferExpanderPlugin | Expands product offer data with validity dates when the product offer is fetched. | | Spryker\Zed\ProductOfferValidity\Communication\Plugin\ProductOffer | +| ProductOfferValidityConsole | Updates product offers to have the `isActive` flag to be `false` where their validity date is not current anymore. | | Spryker\Zed\ProductOfferValidity\Communication\Console | +| MerchantProductOfferStorageMapperPlugin | Maps Merchant foreign key of `ProductOffer` transfer object to Merchant Id `ProductOfferStorage` transfer object. | | Spryker\Zed\MerchantProductOfferStorage\Communication\Plugin\ProductOfferStorage | +| MerchantProductOfferProductConcretePageMapExpanderPlugin | Expands the provided `PageMap` transfer object with related merchant references. | | Spryker\Zed\MerchantProductOfferSearch\Communication\Plugin\ProductPageSearch | +| MerchantProductOfferShipmentTypeStorageFilterPlugin | Filters out `ProductOfferShipmentTypeCollectionTransfer.productOfferShipmentTypes` with product offers with inactive merchants | Requires `ProductOfferShipmentTypeCollectionTransfer.productOfferShipmentTypes.productOffer` to be set. | Spryker\Zed\MerchantProductOfferStorage\Communication\Plugin\ProductOfferShipmentTypeStorage | + +**src/Pyz/Client/Catalog/CatalogDependencyProvider.php** + +```php +|list<\Spryker\Client\SearchExtension\Dependency\Plugin\QueryExpanderPluginInterface> + */ + protected function createCatalogSearchQueryExpanderPlugins(): array + { + return [ + new MerchantReferenceQueryExpanderPlugin(), + ]; + } + + /** + * @return list<\Spryker\Client\Search\Dependency\Plugin\QueryExpanderPluginInterface>|list<\Spryker\Client\SearchExtension\Dependency\Plugin\QueryExpanderPluginInterface> + */ + protected function createSuggestionQueryExpanderPlugins(): array + { + return [ + new MerchantReferenceQueryExpanderPlugin(), + ]; + } + + /** + * @return list<\Spryker\Client\Search\Dependency\Plugin\QueryExpanderPluginInterface>|list<\Spryker\Client\SearchExtension\Dependency\Plugin\QueryExpanderPluginInterface> + */ + protected function getProductConcreteCatalogSearchQueryExpanderPlugins(): array + { + return [ + new MerchantReferenceQueryExpanderPlugin(), + ]; + } +} +``` + +**src/Pyz/Client/Search/SearchDependencyProvider.php** + +```php + + */ + protected function createSearchConfigExpanderPlugins(Container $container): array + { + $searchConfigExpanderPlugins = parent::createSearchConfigExpanderPlugins($container); + $searchConfigExpanderPlugins[] = new MerchantNameSearchConfigExpanderPlugin(); + + return $searchConfigExpanderPlugins; + } +} +``` + +**src/Pyz/Client/SearchElasticsearch/SearchElasticsearchDependencyProvider.php** + +```php + + */ + protected function getSearchConfigExpanderPlugins(Container $container): array + { + return [ + new MerchantNameSearchConfigExpanderPlugin(), + ]; + } +} +``` + +
src/Pyz/Zed/ProductOfferGui/ProductOfferGuiDependencyProvider.php + +```php + + */ + protected function getProductOfferListActionViewDataExpanderPlugins(): array + { + return [ + new MerchantProductOfferListActionViewDataExpanderPlugin(), + ]; + } + + /** + * @return list<\Spryker\Zed\ProductOfferGuiExtension\Dependency\Plugin\ProductOfferTableExpanderPluginInterface> + */ + protected function getProductOfferTableExpanderPlugins(): array + { + return [ + new MerchantProductOfferTableExpanderPlugin(), + ]; + } + + /** + * @return list<\Spryker\Zed\ProductOfferGuiExtension\Dependency\Plugin\ProductOfferViewSectionPluginInterface> + */ + public function getProductOfferViewSectionPlugins(): array + { + return [ + new MerchantProductOfferViewSectionPlugin(), + new ProductOfferValidityProductOfferViewSectionPlugin(), + ]; + } +} +``` +
+ +
src/Pyz/Zed/ProductPageSearch/ProductPageSearchDependencyProvider.php + +```php + + */ + protected function getDataExpanderPlugins(): array + { + $dataExpanderPlugins = []; + $dataExpanderPlugins[MerchantProductOfferSearchConfig::PLUGIN_PRODUCT_MERCHANT_DATA] = new MerchantProductPageDataExpanderPlugin(); + + return $dataExpanderPlugins; + } + + /** + * @return list<\Spryker\Zed\ProductPageSearchExtension\Dependency\Plugin\ProductPageDataLoaderPluginInterface> + */ + protected function getDataLoaderPlugins(): array + { + return [ + new MerchantProductPageDataLoaderPlugin(), + ]; + } + + /** + * @return list<\Spryker\Zed\ProductPageSearchExtension\Dependency\Plugin\ProductAbstractMapExpanderPluginInterface> + */ + protected function getProductAbstractMapExpanderPlugins(): array + { + return [ + new MerchantNamesProductAbstractMapExpanderPlugin(), + new MerchantReferencesProductAbstractsMapExpanderPlugin(), + ]; + } + + /** + * @return list<\Spryker\Zed\ProductPageSearchExtension\Dependency\Plugin\ProductConcretePageMapExpanderPluginInterface> + */ + protected function getConcreteProductMapExpanderPlugins(): array + { + return [ + new MerchantProductOfferProductConcretePageMapExpanderPlugin(), + ]; + } +} +``` +
+ +**src/Pyz/Client/ProductOfferStorage/ProductOfferStorageDependencyProvider.php** + +```php + + */ + protected function getProductOfferReferenceStrategyPlugins(): array + { + return [ + new ProductOfferReferenceStrategyPlugin(), + new DefaultProductOfferReferenceStrategyPlugin(), + ]; + } +} +``` + +**src/Pyz/Client/ProductStorage/ProductStorageDependencyProvider.php** + +```php + + */ + protected function getProductViewExpanderPlugins(): array + { + return [ + new ProductViewProductOfferExpanderPlugin(), + ]; + } +} +``` + +
src/Pyz/Zed/ProductOffer/ProductOfferDependencyProvider.php + +```php + + */ + protected function getProductOfferPostCreatePlugins(): array + { + return [ + new ProductOfferValidityProductOfferPostCreatePlugin(), + ]; + } + + /** + * @return list<\Spryker\Zed\ProductOfferExtension\Dependency\Plugin\ProductOfferPostUpdatePluginInterface> + */ + protected function getProductOfferPostUpdatePlugins(): array + { + return [ + new ProductOfferValidityProductOfferPostUpdatePlugin(), + ]; + } + + /** + * @return list<\Spryker\Zed\ProductOfferExtension\Dependency\Plugin\ProductOfferExpanderPluginInterface> + */ + protected function getProductOfferExpanderPlugins(): array + { + return [ + new ProductOfferValidityProductOfferExpanderPlugin(), + ]; + } +} +``` +
+ +**src/Pyz/Zed/Console/ConsoleDependencyProvider.php** + +```php + + */ + protected function getConsoleCommands(Container $container): array + { + $commands = [ + new ProductOfferValidityConsole(), + ]; + + return $commands; + } +} +``` + +**src/Pyz/Zed/ProductOfferStorage/ProductOfferStorageDependencyProvider.php** + +```php + + */ + protected function getProductOfferStorageMapperPlugins(): array + { + return [ + new MerchantProductOfferStorageMapperPlugin(), + ]; + } +} +``` + +**src/Pyz/Zed/ProductOfferShipmentTypeStorage/ProductOfferShipmentTypeStorageDependencyProvider.php** + +```php + + */ + protected function getProductOfferShipmentTypeStorageFilterPlugins(): array + { + return [ + new MerchantProductOfferShipmentTypeStorageFilterPlugin(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following is true: +* The default product offer is given when retrieving product concrete data. +* The validity data is saved when saving a product offer. +* Merchant and Product Offer Validity sections exist on the product offer view page in `ProductOfferGui`. +* The merchant column is in the Product Offers list, in `ProductOfferGui`. +* The console command invalidates expired product offers and reactivates product offers that are within their validity dates. + +When a merchant gets updated or published, or when a product offer gets published, created, or updated, the corresponding product abstracts get updated in the catalog search pages. + +It means the following: +1. If a merchant gets deactivated, `ProductAbstract` of abstract products that were on the catalog search only because they had a product offer from that merchant get removed. +2. If a product offer gets created, the related `ProductAbstract` that was unavailable on catalog search gets available now. + +{% endinfo_block %} + +### 7) Configure navigation + +1. Add the product offers section to the marketplace section of `navigation.xml`: + +**config/Zed/navigation.xml** + +```xml + + + + + + + Offers + product-offer-gui + list + index + + + + +``` + +2. Execute the following command: + +```bash +console navigation:build-cache +``` + +{% info_block warningBox "Verification" %} + +In the Back Office, make sure that, in Marketplace, the **Offers** menu item is displayed. + +{% endinfo_block %} + + +## Install feature frontend + +Follow the steps below to install the Marketplace Product Offer feature frontend. + +### Prerequisites + +To start feature integration, integrate the following features: + +| NAME | VERSION | INTEGRATION GUIDE | +|----------------------|------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Spryker Core | {{page.version}} | [Spryker Core feature integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/spryker-core-feature-integration.html) | +| Marketplace Merchant | {{page.version}} | [Marketplace Merchant feature integration](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-feature.html) | + +### 1) Install the required modules using Composer + +If already installed, skip this step. + +{% info_block warningBox "Verification" %} + +Verify that the following modules have been installed: + +| MODULE | EXPECTED DIRECTORY | +|-------------------------------------|------------------------------------------------------| +| MerchantProductOfferWidget | spryker-shop/merchant-product-offer-widget | +| MerchantProductOfferWidgetExtension | spryker-shop/merchant-product-offer-widget-extension | +| ProductOfferWidget | spryker-shop/product-offer-widget | + +{% endinfo_block %} + +### 2) Add Translations + +1. Append the glossary according to your configuration: + +**data/import/common/common/glossary.csv** + +``` +merchant_product_offer.view_seller,View Seller,en_US +merchant_product_offer.view_seller,Händler ansehen,de_DE +merchant_product_offer.sold_by,Sold by,en_US +merchant_product_offer.sold_by,Verkauft durch,de_DE +product-offer.info.product-offer-inactive.removed,Inactive item %sku% was removed from your shopping cart.,en_US +product-offer.info.product-offer-inactive.removed,Der inaktive Artikel %sku% wurde aus Ihrem Warenkorb entfernt.,de_DE +product-offer.info.reference.invalid,Product offer reference not found for product with SKU '%sku%'.,en_US +product-offer.info.reference.invalid,Produktangebotsreferenz für Produkt mit SKU '% sku%' nicht gefunden.,de_DE +product-offer.message.not-active-or-approved,"Product offer not active for product with SKU '%sku%'.",en_US +product-offer.message.not-active-or-approved,"Produktangebot ist inaktiv für Produkt mit SKU '%sku%'.",de_DE +merchant_product_offer_widget.merchant_name,Merchant,en_US +merchant_product_offer_widget.merchant_name,Händler,de_DE +``` + +2. Import data: + +```bash +console data:import glossary +``` + +{% info_block warningBox "Verification" %} + +Make sure that the configured data is added to the `spy_glossary_key` and `spy_glossary_translation` tables in the database. + +{% endinfo_block %} + +### 3) Enable controllers + +Register the following route provider on the Storefront: + +| PROVIDER | NAMESPACE | +|-----------------------------------------------|-----------------------------------------------------------| +| MerchantProductOfferWidgetRouteProviderPlugin | SprykerShop\Yves\MerchantProductOfferWidget\Plugin\Router | + +**src/Pyz/Yves/Router/RouterDependencyProvider.php** + +```php + + */ + protected function getRouteProvider(): array + { + return [ + new MerchantProductOfferWidgetRouteProviderPlugin(), + ]; + } +} +``` + +{% info_block warningBox "Verification" %} + +Make sure that the `yves.mysprykershop.com/merchant-product-offer-widget/merchant-product-offers-select` routes is available for `GET` requests. + +{% endinfo_block %} + +### 4) Set up widgets + +1. Register the following plugins to enable widgets: + +| PLUGIN | DESCRIPTION | PREREQUISITES | NAMESPACE | +|-----------------------------------|------------------------------------------------------------------------|---------------|----------------------------------------------------| +| MerchantProductOfferWidget | Shows the list of the offers with their prices for a concrete product. | | SprykerShop\Yves\MerchantProductOfferWidget\Widget | +| MerchantProductOffersSelectWidget | Shows the list of product offers for the concrete product. | | SprykerShop\Yves\MerchantProductOfferWidget\Widget | + +**src/Pyz/Yves/ShopApplication/ShopApplicationDependencyProvider.php** + +```php + + */ + protected function getGlobalWidgets(): array + { + return [ + MerchantProductOfferWidget::class, + MerchantProductOffersSelectWidget::class, + ]; + } +} +``` + +2. Enable Javascript and CSS changes: + +```bash +console frontend:yves:build +``` + +{% info_block warningBox "Verification" %} + +Make sure that the following widgets were registered: + +| MODULE | TEST | +|-----------------------------------|---------------------------------------------------------------------------------------------------------------------------------------| +| MerchantProductOfferWidget | Go to a product concrete details page that has product offers and check if the default offer is selected and the widget is displayed. | +| MerchantProductOffersSelectWidget | Make sure that `ProductConcreteAddWidget` renders the product offers list after performing a product search. | + +{% endinfo_block %} + +### 5) Set up behavior + +Enable the following behaviors by registering the plugins: + +| PLUGIN | DESCRIPTION | PREREQUISITES | NAMESPACE | +|-------------------------------------------------------|----------------------------------------------------------------------------|---------------|------------------------------------------------------------------------| +| MerchantProductOfferProductQuickAddFormExpanderPlugin | Expands `ProductQuickAddForm` with `product_offer_reference` hidden field. | | SprykerShop\Yves\MerchantProductOfferWidget\Plugin\ProductSearchWidget | + +**src/Pyz/Yves/ProductSearchWidget/ProductSearchWidgetDependencyProvider.php** + +```php + + */ + protected function getProductQuickAddFormExpanderPlugins(): array + { + return [ + new MerchantProductOfferProductQuickAddFormExpanderPlugin(), + ]; + } +} +``` + +## Related features + +| FEATURE | REQUIRED FOR THE CURRENT FEATURE | INTEGRATION GUIDE | +|------------------------------------------------------|----------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Combined Product Offer Import | | [Combined Product Offer Import integration](/docs/marketplace/dev/feature-integration-guides/{{page.version}}/combined-product-offer-import-feature-integration.html) | +| Marketplace Product Offer Prices | | [Marketplace Product Offer Prices feature integration](/docs/pbc/all/price-management/{{site.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-prices-feature.html) | +| Marketplace Merchant Portal Product Offer Management | | [Marketplace Product Offer Management feature integration](/docs/marketplace/dev/feature-integration-guides/{{page.version}}/marketplace-merchant-portal-product-offer-management-feature-integration.html) | +| Marketplace Product Offer API | | [Glue API: Marketplace Product Offer feature integration](/docs/marketplace/dev/feature-integration-guides/{{page.version}}/glue/marketplace-product-offer-feature-integration.html) | +| Marketplace Product + Marketplace Product Offer | | [Marketplace Product + Marketplace Product Offer feature integration](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-marketplace-product-offer-feature.html) | +| Marketplace Product Offer + Cart | | [Marketplace Product Offer + Cart feature integration](/docs/marketplace/dev/feature-integration-guides/{{page.version}}/marketplace-product-offer-cart-feature-integration.html) | +| Marketplace Product Offer + Checkout | | [Marketplace Product Offer + Checkout feature integration](/docs/marketplace/dev/feature-integration-guides/{{page.version}}/marketplace-product-offer-checkout-feature-integration.html) | +| Marketplace Product Offer + Prices | | [Marketplace Product Offer + Prices feature integration](/docs/pbc/all/price-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-prices-feature.html) | +| Marketplace Product Offer + Quick Add to Cart | | [Marketplace Product Offer + Quick Add to Cart feature integration](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-quick-add-to-cart-feature.html) | diff --git a/docs/pbc/all/offer-management/202304.0/marketplace/install-and-upgrade/marketplace-product-offer-feature-integration.md b/docs/pbc/all/offer-management/202304.0/marketplace/install-and-upgrade/marketplace-product-offer-feature-integration.md index d92b5a200f7..59670747379 100644 --- a/docs/pbc/all/offer-management/202304.0/marketplace/install-and-upgrade/marketplace-product-offer-feature-integration.md +++ b/docs/pbc/all/offer-management/202304.0/marketplace/install-and-upgrade/marketplace-product-offer-feature-integration.md @@ -1,6 +1,6 @@ --- title: Marketplace Product Offer feature integration -last_updated: Jan 11, 2023 +last_updated: Jun 16, 2023 description: This document describes the process how to integrate the Marketplace Product Offer feature into a Spryker project. template: feature-integration-guide-template related: @@ -8,1757 +8,4 @@ related: link: docs/pbc/all/offer-management/page.version/marketplace/marketplace-merchant-portal-product-offer-management-feature-overview.html --- -This document describes how to integrate the [Marketplace Product Offer](/docs/pbc/all/offer-management/{{page.version}}/marketplace/marketplace-product-offer-feature-overview.html) into a Spryker project. - -## Install feature core - -Follow the steps below to install the Marketplace Product Offer feature core. - -### Prerequisites - -To start feature integration, integrate the required features: - -| NAME | VERSION | INTEGRATION GUIDE | -| --------------- | ------- | -------| -| Spryker Core | {{page.version}} | [Spryker Core feature integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/spryker-core-feature-integration.html) | -| Marketplace Merchant | {{page.version}} | [Marketplace Merchant feature integration](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-feature.html) | -| Product | {{page.version}} | [Product feature integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/product-feature-integration.html) | - -### 1) Install the required modules using Composer - - -```bash -composer require spryker-feature/marketplace-product-offer:"{{page.version}}" --update-with-dependencies -``` - -{% info_block warningBox "Verification" %} - -Make sure that the following modules have been installed: - -| MODULE | EXPECTED DIRECTORY | -|--------------------------------|--------------------------------------------| -| MerchantProductOffer | spryker/merchant-product-offer | -| MerchantProductOfferDataImport | spryker/merchant-product-offer-data-import | -| MerchantProductOfferGui | spryker/merchant-product-offer-gui | -| MerchantProductOfferSearch | spryker/merchant-product-offer-search | -| MerchantProductOfferStorage | spryker/merchant-product-offer-storage | -| ProductOffer | spryker/product-offer | -| ProductOfferGui | spryker/product-offer-gui | -| ProductOfferValidity | spryker/product-offer-validity | -| ProductOfferValidityDataImport | spryker/product-offer-validity-data-import | -| ProductOfferValidityGui | spryker/product-offer-validity-gui | -| ProductOfferStorage | spryker/product-offer-storage | -| ProductOfferStorageExtension | spryker/product-offer-storage-extension | - -{% endinfo_block %} - -### 2) Set up database schema and transfer objects - -1. Adjust the schema definition so that entity changes trigger events: - -**src/Pyz/Zed/ProductOffer/Persistence/Propel/Schema/spy_product_offer.schema.xml** - -```xml - - - - - - - - - -
- - - - - -
- -``` - -2. Apply database changes and to generate entity and transfer changes: - -```bash -console transfer:generate -console propel:install -console transfer:generate -``` - -{% info_block warningBox "Verification" %} - -Verify that the following changes have been implemented by checking your database: - -| DATABASE ENTITY | TYPE | EVENT | -| -------------------------- | ----- | ------ | -| spy_product_offer | table | created | -| spy_product_offer_store | table | created | -| spy_product_concrete_product_offers_storage | table | created | -| spy_product_offer_storage | table | created | -| spy_product_offer_validity | table | created | - -Make sure that the following changes have been applied in transfer objects: - -| TRANSFER | TYPE | EVENT | PATH | -|--------------------------------------------|----------|---------|----------------------------------------------------------------------| -| Item.productOfferReference | property | created | src/Generated/Shared/Transfer/ItemTransfer | -| MerchantProductOfferCriteria | class | created | src/Generated/Shared/Transfer/MerchantProductOfferCriteriaTransfer | -| MerchantProductOfferConditions | class | created | src/Generated/Shared/Transfer/MerchantProductOfferConditionsTransfer | -| Pagination | class | created | src/Generated/Shared/Transfer/PaginationTransfer | -| PageMap.merchantReferences | property | created | src/Generated/Shared/Transfer/PageMapTransfer | -| ProductAbstractMerchant.merchantReferences | property | created | src/Generated/Shared/Transfer/ProductAbstractMerchantTransfer | -| ProductOffer | class | created | src/Generated/Shared/Transfer/ProductOfferTransfer | -| ProductOfferCollection | class | created | src/Generated/Shared/Transfer/ProductOfferCollectionTransfer | -| ProductOfferCriteria | class | created | src/Generated/Shared/Transfer/ProductOfferCriteriaTransfer | -| ProductOfferError | class | created | src/Generated/Shared/Transfer/ProductOfferErrorTransfer | -| ProductOfferResponse | class | created | src/Generated/Shared/Transfer/ProductOfferResponseTransfer | -| ProductOfferStorage | class | created | src/Generated/Shared/Transfer/ProductOfferStorageTransfer | -| ProductOfferStorageCollection | class | created | src/Generated/Shared/Transfer/ProductOfferStorageCollectionTransfer | -| ProductOfferStorageCriteria | class | created | src/Generated/Shared/Transfer/ProductOfferStorageCriteriaTransfer | -| ProductOfferStore | class | created | src/Generated/Shared/Transfer/ProductOfferStoreTransfer | -| ProductOfferValidity | class | created | src/Generated/Shared/Transfer/ProductOfferValidityTransfer | -| ProductOfferValidityCollection | class | created | src/Generated/Shared/Transfer/ProductOfferValidityCollectionTransfer | -| EventEntity | class | created | src/Generated/Shared/Transfer/EventEntityTransfer | -| ProductConcretePageSearch | class | created | src/Generated/Shared/Transfer/ProductConcretePageSearchTransfer | -| ProductPageSearch.merchantReferences | property | created | src/Generated/Shared/Transfer/ProductPageSearchTransfer | -| ProductPayload.merchantReferences | property | created | src/Generated/Shared/Transfer/ProductPayloadTransfer | -| ProductStorageCriteria.merchantReference | property | created | src/Generated/Shared/Transfer/ProductStorageCriteriaTransfer | -| ProductView.productOfferReference | property | created | src/Generated/Shared/Transfer/ProductViewTransfer | -| Merchant.merchantReference | property | created | src/Generated/Shared/Transfer/MerchantTransfer | -| Merchant.status | property | created | src/Generated/Shared/Transfer/MerchantTransfer | - -{% endinfo_block %} - -### 3) Add translations - -Generate a new translation cache for Zed: - -```bash -console translator:generate-cache -``` - -### 4) Configure export to Redis and Elasticsearch - -To configure export to Redis and Elasticsearch, take the steps in the following subsections. - -#### Set up publisher plugins - -| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | -|--|--| ----------- | ---------------- | -| ProductConcreteProductOffersDeletePublisherPlugin | Finds and deletes product concrete offer storage entities by the given concreteSkus. | | Spryker\Zed\ProductOfferStorage\Communication\Plugin\Publisher\ProductConcreteOffers | -| ProductConcreteProductOffersWritePublisherPlugin | Queries all active product offer with the given concreteSkus, stores data as json encoded to storage table. | | Spryker\Zed\ProductOfferStorage\Communication\Plugin\Publisher\ProductConcreteOffers | -| ProductOfferDeletePublisherPlugin | Finds and deletes product offer storage entities with the given productOfferReferences, sends delete message to queue based on module config. | | Spryker\Zed\ProductOfferStorage\Communication\Plugin\Publisher\ProductOffer | -| ProductOfferWritePublisherPlugin | Queries all active product offer with the given productOfferReferences, stores data as json encoded to storage table. | | Spryker\Zed\ProductOfferStorage\Communication\Plugin\Publisher\ProductOffer | -| MerchantProductConcreteProductOfferWritePublisherPlugin | Retrieves all active product offers by `merchantIds`, publish active product offers data to `ProductConcreteProductOffersStorage`. | | Spryker\Zed\MerchantProductOfferStorage\Communication\Plugin\Publisher\ProductConcreteProductOffer | -| MerchantProductOfferWritePublisherPlugin | Queries all active product offer with the given merchantIds, stores data as json encoded to storage table. | | Spryker\Zed\MerchantProductOfferStorage\Communication\Plugin\Publisher\Merchant | -| ProductConcreteWritePublisherPlugin | Publishes concrete products by create, update, and delete product offer events. | | Spryker\Zed\MerchantProductOfferSearch\Communication\Plugin\Publisher\ProductOffer | -| ProductConcreteWritePublisherPlugin | Publishes concrete products by create, update, and delete product offer store events. | | Spryker\Zed\MerchantProductOfferSearch\Communication\Plugin\Publisher\ProductOfferStore | -| MerchantProductOfferSearchPublisherTriggerPlugin | Allows publishing or republishing product offer search data manually. | | Spryker\Zed\MerchantProductOfferSearch\Communication\Plugin\Publisher | -| ProductOfferPublisherTriggerPlugin | Allows publishing or republishing product offer data manually. | | Spryker\Zed\ProductOfferStorage\Communication\Plugin\Publisher | - -
src/Pyz/Zed/Publisher/PublisherDependencyProvider.php - -```php -getProductOfferStoragePlugins(), - $this->getMerchantProductOfferStoragePlugins(), - ); - } - - /** - * @return array<\Spryker\Zed\PublisherExtension\Dependency\Plugin\PublisherPluginInterface> - */ - protected function getProductOfferStoragePlugins(): array - { - return [ - new ProductConcreteProductOffersDeletePublisherPlugin(), - new ProductConcreteProductOffersWritePublisherPlugin(), - new ProductOfferDeletePublisherPlugin(), - new ProductOfferWritePublisherPlugin(), - ]; - } - - /** - * @return array<\Spryker\Zed\PublisherExtension\Dependency\Plugin\PublisherPluginInterface> - */ - protected function getMerchantProductOfferStoragePlugins(): array - { - return [ - new MerchantProductConcreteProductOfferWritePublisherPlugin(), - new MerchantProductOfferWritePublisherPlugin(), - ]; - } - - /** - * @return array<\Spryker\Zed\PublisherExtension\Dependency\Plugin\PublisherPluginInterface> - */ - protected function getMerchantProductOfferSearchPlugins(): array - { - return [ - new ProductOfferProductConcreteWritePublisherPlugin(), - new ProductOfferStoreProductConcreteWritePublisherPlugin(), - ]; - } - - /** - * @return array<\Spryker\Zed\PublisherExtension\Dependency\Plugin\PublisherTriggerPluginInterface> - */ - protected function getPublisherTriggerPlugins(): array - { - return [ - new MerchantProductOfferSearchPublisherTriggerPlugin(), - new ProductOfferPublisherTriggerPlugin(), - ]; - } -} -``` -
- -#### Set up event listeners - -{% info_block infoBox %} - -In this step, you enable the publishing of `spy_merchant` and `spy_product_offer` changes (create, update, and delete) to `spy_product_abstract_page_search` and `spy_product_concrete_page_search` and synchronization of data to Search. - -{% endinfo_block %} - -Set up the following plugins: - -| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | -| --------------- |----------------------| ----------- | ---------------- | -| MerchantProductOfferSearchEventSubscriber | Registers listeners responsible for publishing merchant product offer search to storage. | | Spryker\Zed\MerchantProductOfferSearch\Communication\Plugin\Event\Subscriber | -| MerchantSearchEventSubscriber | Registers listeners responsible for publishing merchant search to storage. | | Spryker\Zed\MerchantProductOfferSearch\Communication\Plugin\Event\Subscriber | - -**src/Pyz/Zed/Event/EventDependencyProvider.php** - -```php -add(new MerchantSearchEventSubscriber()); - $eventSubscriberCollection->add(new MerchantProductOfferSearchEventSubscriber()); - - return $eventSubscriberCollection; - } -} -``` - -#### Register the synchronization queue and synchronization error queue - -**src/Pyz/Client/RabbitMq/RabbitMqConfig.php** - -```php - - */ - protected function getProcessorMessagePlugins(Container $container) - { - return [ - ProductOfferStorageConfig::PRODUCT_OFFER_SYNC_STORAGE_QUEUE => new SynchronizationStorageQueueMessageProcessorPlugin(), - ]; - } -} -``` - -#### Set up, regenerate, and resync features - -1. Set up the following plugins: - -| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | -| ----------------- | --------------- | ---------- | ---------------- | -| ProductConcreteProductOffersSynchronizationDataBulkRepositoryPlugin | Allows synchronizing the entire storage table content into Storage. | | Spryker\Zed\ProductOfferStorage\Communication\Plugin\Synchronization | -| ProductOfferSynchronizationDataBulkRepositoryPlugin | Allows synchronizing the entire storage table content into Storage. | | Spryker\Zed\ProductOfferStorage\Communication\Plugin\Synchronization | - -**src/Pyz/Zed/Synchronization/SynchronizationDependencyProvider.php** - -```php - - */ - protected function getSynchronizationDataPlugins(): array - { - return [ - new ProductConcreteProductOffersSynchronizationDataBulkRepositoryPlugin(), - new ProductOfferSynchronizationDataBulkRepositoryPlugin(), - ]; - } -} -``` - -2. Configure synchronization storage: - -**src/Pyz/Zed/ProductOfferStorage/ProductOfferStorageConfig.php** - -```php -data/import/common/common/marketplace/merchant_product_offer.csv - -``` -product_offer_reference,concrete_sku,merchant_reference,merchant_sku,is_active,approval_status -offer1,093_24495843,MER000001,GS952M00H-Q11,1,approved -offer2,090_24495844,MER000002,,1,approved -offer3,091_25873091,MER000001,M9122A0AQ-C11,1,approved -offer4,091_25873091,MER000002,M9122A0AQ-C11,1,approved -offer5,092_24495842,MER000001,TH344E01G-Q11,0,approved -offer6,092_24495842,MER000002,OB054P005-Q11,1,approved -offer7,193_32124735,MER000001,,1,approved -offer8,001_25904006,MER000002,,1,approved -offer9,002_25904004,MER000002,,0,approved -offer10,003_26138343,MER000002,,0,waiting_for_approval -offer11,004_30663302,MER000002,,1,waiting_for_approval -offer12,005_30663301,MER000002,,1,approved -offer13,006_30692993,MER000002,,1,approved -offer14,007_30691822,MER000002,,1,approved -offer15,008_30692992,MER000002,,1,approved -offer16,009_30692991,MER000002,,1,approved -offer17,010_30692994,MER000002,,1,approved -offer18,011_30775359,MER000002,,1,approved -offer19,012_25904598,MER000002,,1,approved -offer20,013_25904584,MER000002,,1,approved -offer21,014_25919241,MER000002,,1,approved -offer22,015_25904009,MER000002,,1,approved -offer23,016_21748907,MER000002,,1,approved -offer24,017_21748906,MER000002,,1,approved -offer25,018_21081477,MER000002,,1,approved -offer26,019_21081473,MER000002,,1,approved -offer27,020_21081478,MER000002,,1,approved -offer28,021_21081475,MER000002,,1,approved -offer29,022_21994751,MER000002,,1,approved -offer30,023_21758366,MER000002,,1,approved -offer31,024_21987578,MER000002,,1,approved -offer32,025_21764665,MER000002,,1,approved -offer33,026_21748904,MER000002,,1,approved -offer34,027_26976107,MER000002,,1,approved -offer35,028_26976108,MER000002,,1,approved -offer36,029_26976109,MER000002,,1,approved -offer37,030_30021698,MER000002,,1,approved -offer38,031_30021637,MER000002,,1,approved -offer39,032_32125551,MER000002,,1,approved -offer40,033_32125568,MER000002,,1,approved -offer41,034_32125390,MER000002,,1,approved -offer42,035_17360369,MER000002,,1,approved -offer43,036_17360368,MER000002,,1,approved -offer44,037_25904011,MER000002,,1,approved -offer45,038_25905593,MER000002,,1,approved -offer46,039_25904010,MER000002,,1,approved -offer47,040_25904665,MER000002,,1,approved -offer48,041_25904691,MER000002,,1,approved -offer49,001_25904006,MER000005,,1,approved -offer50,002_25904004,MER000005,,1,approved -offer51,003_26138343,MER000005,,0,approved -offer52,004_30663302,MER000005,,1,approved -offer53,005_30663301,MER000005,,0,approved -offer54,006_30692993,MER000005,,1,approved -offer55,007_30691822,MER000005,,1,waiting_for_approval -offer56,008_30692992,MER000005,,1,waiting_for_approval -offer57,009_30692991,MER000005,,1,approved -offer58,010_30692994,MER000005,,1,approved -offer59,011_30775359,MER000005,,1,approved -offer60,012_25904598,MER000005,,1,approved -offer61,013_25904584,MER000005,,1,approved -offer62,014_25919241,MER000005,,1,approved -offer63,015_25904009,MER000005,,1,approved -offer64,016_21748907,MER000005,,1,approved -offer65,017_21748906,MER000005,,1,approved -offer66,018_21081477,MER000005,,1,approved -offer67,019_21081473,MER000005,,1,approved -offer68,020_21081478,MER000005,,1,approved -offer69,021_21081475,MER000005,,1,approved -offer70,022_21994751,MER000005,,1,approved -offer71,023_21758366,MER000005,,1,approved -offer72,024_21987578,MER000005,,1,approved -offer73,025_21764665,MER000005,,1,approved -offer74,026_21748904,MER000005,,1,approved -offer75,027_26976107,MER000005,,1,approved -offer76,028_26976108,MER000005,,1,approved -offer77,029_26976109,MER000005,,1,approved -offer78,030_30021698,MER000005,,1,approved -offer79,031_30021637,MER000005,,1,approved -offer80,032_32125551,MER000005,,1,approved -offer81,033_32125568,MER000005,,1,approved -offer82,034_32125390,MER000005,,1,approved -offer83,035_17360369,MER000005,,1,approved -offer84,036_17360368,MER000005,,1,approved -offer85,037_25904011,MER000005,,1,approved -offer86,038_25905593,MER000005,,1,approved -offer87,039_25904010,MER000005,,1,approved -offer88,040_25904665,MER000005,,1,approved -offer89,041_25904691,MER000005,,1,approved -offer90,016_21748907,MER000006,,1,approved -offer91,017_21748906,MER000006,,1,waiting_for_approval -offer92,018_21081477,MER000006,,1,approved -offer93,019_21081473,MER000006,,0,approved -offer94,020_21081478,MER000006,,1,approved -offer95,021_21081475,MER000006,,1,approved -offer96,022_21994751,MER000006,,1,approved -offer97,023_21758366,MER000006,,1,approved -offer98,024_21987578,MER000006,,1,approved -offer99,025_21764665,MER000006,,1,approved -offer100,026_21748904,MER000006,,0,approved -offer101,027_26976107,MER000006,,1,approved -offer102,028_26976108,MER000006,,1,approved -offer103,029_26976109,MER000006,,1,waiting_for_approval -offer169,076_24394207,MER000006,,1,approved -offer170,077_24584210,MER000006,,1,approved -offer171,078_24602396,MER000006,,1,approved -offer172,079_24394211,MER000006,,1,approved -offer173,080_24394206,MER000006,,1,approved -offer348,193_32124735,MER000006,,1,approved -offer349,194_25904145,MER000006,,1,approved -offer350,195_25904159,MER000006,,1,approved -offer351,196_23120327,MER000006,,1,approved -offer352,197_21421718,MER000006,,1,approved -offer353,198_19692589,MER000006,,1,approved -offer354,199_7016823,MER000006,,1,approved -offer355,199_24788780,MER000006,,1,approved -offer356,200_5787536,MER000006,,1,approved -offer357,201_11217755,MER000006,,1,approved -offer358,202_5782479,MER000006,,1,approved -offer359,203_15619960,MER000006,,1,approved -offer360,204_29851280,MER000006,,1,approved -offer402,101_29727910,MER000004,,1,approved -offer403,102_30727008,MER000005,,0,approved -offer404,102_30727008,MER000005,,1,denied -offer405,102_30727008,MER000005,,1,waiting_for_approval -offer410,104_30727010,MER000005,,1,approved -offer411,113_29885591,MER000005,,1,approved -offer412,113_29885591,MER000002,,1,approved -offer413,118_29804739,MER000005,,1,approved -offer414,118_29804739,MER000002,,1,approved -offer415,112_312526171,MER000005,,1,approved -offer416,112_306918001,MER000002,,1,approved -offer417,112_312526191,MER000005,,1,approved -offer418,112_312526172,MER000002,,1,approved -``` - - -| COLUMN | REQUIRED | DATA TYPE | DATA EXAMPLE | DATA EXPLANATION | -| -------------- | ----------- | -------- | --------- | ------------------ | -| product_offer_reference | ✓ | string | offer1 | Product offer reference that is referenced to this merchant. | -| concrete_sku | ✓ | string | 093_24495843 | Concrete product SKU this product offer is attached to. | -| merchant_reference | ✓ | string | `MER000002` | Merchant identifier. | -| merchant_sku | | string | GS952M00H-Q11 | merchant internal SKU for the product offer. | -| is_active | | boolean | 1 | Product offer status, defaults to 1. | -| approval_status | | string | approved | Approval status (Waiting for Approval – Approved – Denied). Denied and Waiting for Approval statuses mean that the offer is not visible on PDP regardless of Product Offer → Active = true.This can be configured (along with the transition between statuses in ProductOfferConfig). If not supplied, ProductOfferConfig → getDefaultStatus is applied. | - -
data/import/common/common/marketplace/merchant_product_offer_store.csv - -``` -product_offer_reference,store_name -offer1,DE -offer2,DE -offer3,DE -offer4,DE -offer6,DE -offer7,DE -offer8,DE -offer9,DE -offer10,DE -offer11,DE -offer12,DE -offer13,DE -offer14,DE -offer15,DE -offer16,DE -offer17,DE -offer18,DE -offer19,DE -offer20,DE -offer21,DE -offer22,DE -offer23,DE -offer24,DE -offer25,DE -offer26,DE -offer27,DE -offer28,DE -offer29,DE -offer30,DE -offer31,DE -offer32,DE -offer33,DE -offer34,DE -offer35,DE -offer36,DE -offer37,DE -offer38,DE -offer39,DE -offer40,DE -offer41,DE -offer42,DE -offer43,DE -offer44,DE -offer45,DE -offer46,DE -offer47,DE -offer48,DE -offer49,DE -offer50,DE -offer51,DE -offer52,DE -offer53,DE -offer54,DE -offer55,DE -offer56,DE -offer57,DE -offer58,DE -offer59,DE -offer60,DE -offer61,DE -offer62,DE -offer63,DE -offer64,DE -offer65,DE -offer66,DE -offer67,DE -offer68,DE -offer69,DE -offer70,DE -offer71,DE -offer72,DE -offer73,DE -offer74,DE -offer75,DE -offer76,DE -offer77,DE -offer78,DE -offer79,DE -offer80,DE -offer81,DE -offer82,DE -offer83,DE -offer84,DE -offer85,DE -offer86,DE -offer87,DE -offer88,DE -offer89,DE -offer90,DE -offer91,DE -offer92,DE -offer93,DE -offer94,DE -offer95,DE -offer96,DE -offer97,DE -offer98,DE -offer99,DE -offer100,DE -offer101,DE -offer102,DE -offer103,DE -offer169,DE -offer170,DE -offer171,DE -offer172,DE -offer173,DE -offer348,DE -offer349,DE -offer350,DE -offer351,DE -offer352,DE -offer353,DE -offer354,DE -offer355,DE -offer356,DE -offer357,DE -offer358,DE -offer359,DE -offer360,DE -offer402,DE -offer403,DE -offer404,DE -offer405,DE -offer410,DE -offer411,DE -offer412,DE -offer413,DE -offer414,DE -offer415,DE -offer416,DE -offer417,DE -offer418,DE -offer2,US -offer4,US -offer6,US -offer7,US -offer8,US -offer9,US -offer10,US -offer11,US -offer12,US -offer13,US -offer14,US -offer15,US -offer16,US -offer17,US -offer18,US -offer19,US -offer20,US -offer21,US -offer22,US -offer23,US -offer24,US -offer25,US -offer26,US -offer27,US -offer28,US -offer29,US -offer30,US -offer31,US -offer32,US -offer33,US -offer34,US -offer35,US -offer36,US -offer37,US -offer38,US -offer39,US -offer40,US -offer41,US -offer42,US -offer43,US -offer44,US -offer45,US -offer46,US -offer47,US -offer48,US -offer49,US -offer50,US -offer51,US -offer52,US -offer53,US -offer54,US -offer55,US -offer56,US -offer57,US -offer58,US -offer59,US -offer60,US -offer61,US -offer62,US -offer63,US -offer64,US -offer65,US -offer66,US -offer67,US -offer68,US -offer69,US -offer70,US -offer71,US -offer72,US -offer73,US -offer74,US -offer75,US -offer76,US -offer77,US -offer78,US -offer79,US -offer80,US -offer81,US -offer82,US -offer83,US -offer84,US -offer85,US -offer86,US -offer87,US -offer88,US -offer89,US -offer90,US -offer91,US -offer92,US -offer93,US -offer94,US -offer95,US -offer96,US -offer97,US -offer98,US -offer99,US -offer100,US -offer101,US -offer102,US -offer103,US -offer169,US -offer170,US -offer171,US -offer172,US -offer173,US -offer348,US -offer349,US -offer350,US -offer351,US -offer352,US -offer353,US -offer354,US -offer355,US -offer356,US -offer357,US -offer358,US -offer359,US -offer360,US -offer1,AT -offer2,AT -offer3,AT -offer4,AT -offer6,AT -offer7,AT -offer8,AT -offer9,AT -offer10,AT -offer11,AT -offer12,AT -offer13,AT -offer14,AT -offer15,AT -offer16,AT -offer17,AT -offer18,AT -offer19,AT -offer20,AT -offer21,AT -offer22,AT -offer23,AT -offer24,AT -offer25,AT -offer26,AT -offer27,AT -offer28,AT -offer29,AT -offer30,AT -offer31,AT -offer32,AT -offer33,AT -offer34,AT -offer35,AT -offer36,AT -offer37,AT -offer38,AT -offer39,AT -offer40,AT -offer41,AT -offer42,AT -offer43,AT -offer44,AT -offer45,AT -offer46,AT -offer47,AT -offer48,AT -offer49,AT -offer50,AT -offer51,AT -offer52,AT -offer53,AT -offer54,AT -offer55,AT -offer56,AT -offer57,AT -offer58,AT -offer59,AT -offer60,AT -offer61,AT -offer62,AT -offer63,AT -offer64,AT -offer65,AT -offer66,AT -offer67,AT -offer68,AT -offer69,AT -offer70,AT -offer71,AT -offer72,AT -offer73,AT -offer74,AT -offer75,AT -offer76,AT -offer77,AT -offer78,AT -offer79,AT -offer80,AT -offer81,AT -offer82,AT -offer83,AT -offer84,AT -offer85,AT -offer86,AT -offer87,AT -offer88,AT -offer89,AT -offer90,AT -offer91,AT -offer92,AT -offer93,AT -offer94,AT -offer95,AT -offer96,AT -offer97,AT -offer98,AT -offer99,AT -offer100,AT -offer101,AT -offer102,AT -offer103,AT -offer169,AT -offer170,AT -offer171,AT -offer172,AT -offer173,AT -offer348,AT -offer349,AT -offer350,AT -offer351,AT -offer352,AT -offer353,AT -offer354,AT -offer355,AT -offer356,AT -offer357,AT -offer358,AT -offer359,AT -offer360,AT -offer402,AT -offer403,AT -offer404,AT -offer405,AT -offer410,AT -offer411,AT -offer412,AT -offer413,AT -offer414,AT -offer415,AT -offer416,AT -offer417,AT -offer418,AT -``` -
- -| COLUMN | REQUIRED | DATA TYPE | DATA EXAMPLE | DATA EXPLANATION | -| ---------------- | ------------ | ------- | ------------- | ------- | -| product_offer_reference | ✓ | string | roan-gmbh-und-co-k-g | A product offer reference, unique identifier per Offer. | -| store_name | ✓ | string | DE | The name of the store. | - -**data/import/common/common/marketplace/product_offer_validity.csv** - -``` -product_offer_reference,valid_from,valid_to -offer1,,2020-01-20 00:00:00.000000 -offer2,,2020-01-20 00:00:00.000000 -offer3,,2020-01-20 00:00:00.000000 -offer4,,2020-01-20 00:00:00.000000 -offer5,2030-01-01 00:00:00.000000, -offer6,2030-01-01 00:00:00.000000, -offer7,2030-01-01 00:00:00.000000, -offer8,2030-01-01 00:00:00.000000, -offer9,2020-07-01 00:00:00.000000,2025-12-01 00:00:00.000000 -offer10,2020-07-01 00:00:00.000000,2025-12-01 00:00:00.000000 -offer49,,2020-01-20 00:00:00.000000 -offer50,,2020-01-20 00:00:00.000000 -offer51,2030-01-01 00:00:00.000000, -offer52,2030-01-01 00:00:00.000000, -offer53,2020-07-01 00:00:00.000000,2025-12-01 00:00:00.000000 -offer54,2020-07-01 00:00:00.000000,2025-12-01 00:00:00.000000 -offer90,,2020-01-20 00:00:00.000000 -offer91,,2020-01-20 00:00:00.000000 -offer92,2030-01-01 00:00:00.000000, -offer93,2030-01-01 00:00:00.000000, -offer94,2020-07-01 00:00:00.000000,2025-12-01 00:00:00.000000 -offer95,2020-07-01 00:00:00.000000,2025-12-01 00:00:00.000000 -``` - -| COLUMN | REQUIRED | DATA TYPE | DATA EXAMPLE | DATA EXPLANATION | -| ------------ |-----------|-----------| ----------- | ---------------- | -| product_offer_reference | ✓ | string | offer1 | A unique product offer identifier. | -| valid_from | | String | 2020-01-01 | Date since which the product offer is valid. | -| valid_to | | String | 2020-01-01 | Date until which the product offer is valid. | - -2. Register the following plugins to enable data import: - -| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE | -| ------------------ |----------------| ---------- | ---------------------- | -| MerchantProductOfferDataImportPlugin | Imports merchant product offer data. | | Spryker\Zed\MerchantProductOfferDataImport\Communication\Plugin\DataImport | -| MerchantProductOfferStoreDataImportPlugin | Imports the product offer to store relation data. | | Spryker\Zed\MerchantProductOfferDataImport\Communication\Plugin\DataImport | -| ProductOfferValidityDataImportPlugin | Imports product offer validity data. | | Spryker\Zed\ProductOfferValidityDataImport\Communication\DataImport | - -**src/Pyz/Zed/DataImport/DataImportDependencyProvider.php** - -```php -src/Pyz/Client/Catalog/CatalogDependencyProvider.php - -```php -|array<\Spryker\Client\SearchExtension\Dependency\Plugin\QueryExpanderPluginInterface> - */ - protected function createCatalogSearchQueryExpanderPlugins() - { - return [ - new MerchantReferenceQueryExpanderPlugin(), - ]; - } - - /** - * @return array<\Spryker\Client\Search\Dependency\Plugin\QueryExpanderPluginInterface>|array<\Spryker\Client\SearchExtension\Dependency\Plugin\QueryExpanderPluginInterface> - */ - protected function createSuggestionQueryExpanderPlugins() - { - return [ - new MerchantReferenceQueryExpanderPlugin(), - ]; - } - - /** - * @return array<\Spryker\Client\Search\Dependency\Plugin\QueryExpanderPluginInterface>|array<\Spryker\Client\SearchExtension\Dependency\Plugin\QueryExpanderPluginInterface> - */ - protected function getProductConcreteCatalogSearchQueryExpanderPlugins(): array - { - return [ - new MerchantReferenceQueryExpanderPlugin(), - ]; - } -} -``` - - -**src/Pyz/Client/Search/SearchDependencyProvider.php** - -```php - - */ - protected function createSearchConfigExpanderPlugins(Container $container) - { - $searchConfigExpanderPlugins = parent::createSearchConfigExpanderPlugins($container); - - $searchConfigExpanderPlugins[] = new MerchantNameSearchConfigExpanderPlugin(); - - return $searchConfigExpanderPlugins; - } -} -``` - -**src/Pyz/Client/SearchElasticsearch/SearchElasticsearchDependencyProvider.php** - -```php - - */ - protected function getSearchConfigExpanderPlugins(Container $container): array - { - return [ - new MerchantNameSearchConfigExpanderPlugin(), - ]; - } -} -``` - -
src/Pyz/Zed/ProductOfferGui/ProductOfferGuiDependencyProvider.php - -```php - - */ - protected function getProductOfferListActionViewDataExpanderPlugins(): array - { - return [ - new MerchantProductOfferListActionViewDataExpanderPlugin(), - ]; - } - - /** - * @return array<\Spryker\Zed\ProductOfferGuiExtension\Dependency\Plugin\ProductOfferTableExpanderPluginInterface> - */ - protected function getProductOfferTableExpanderPlugins(): array - { - return [ - new MerchantProductOfferTableExpanderPlugin(), - ]; - } - - /** - * @return array<\Spryker\Zed\ProductOfferGuiExtension\Dependency\Plugin\ProductOfferViewSectionPluginInterface> - */ - public function getProductOfferViewSectionPlugins(): array - { - return [ - new MerchantProductOfferViewSectionPlugin(), - new ProductOfferValidityProductOfferViewSectionPlugin(), - ]; - } -} -``` -
- -
src/Pyz/Zed/ProductPageSearch/ProductPageSearchDependencyProvider.php - -```php - - */ - protected function getDataExpanderPlugins() - { - $dataExpanderPlugins = []; - - $dataExpanderPlugins[MerchantProductOfferSearchConfig::PLUGIN_PRODUCT_MERCHANT_DATA] = new MerchantProductPageDataExpanderPlugin(); - - return $dataExpanderPlugins; - } - - /** - * @return array<\Spryker\Zed\ProductPageSearchExtension\Dependency\Plugin\ProductPageDataLoaderPluginInterface> - */ - protected function getDataLoaderPlugins() - { - return [ - new MerchantProductPageDataLoaderPlugin(), - ]; - } - - /** - * @return array<\Spryker\Zed\ProductPageSearchExtension\Dependency\Plugin\ProductAbstractMapExpanderPluginInterface> - */ - protected function getProductAbstractMapExpanderPlugins(): array - { - return [ - new MerchantNamesProductAbstractMapExpanderPlugin(), - new MerchantReferencesProductAbstractsMapExpanderPlugin(), - ]; - } - - /** - * @return array<\Spryker\Zed\ProductPageSearchExtension\Dependency\Plugin\ProductConcretePageMapExpanderPluginInterface> - */ - protected function getConcreteProductMapExpanderPlugins(): array - { - return [ - new MerchantProductOfferProductConcretePageMapExpanderPlugin(), - ]; - } -} -``` -
- -**src/Pyz/Client/ProductOfferStorage/ProductOfferStorageDependencyProvider.php** - -```php - - */ - protected function getProductOfferReferenceStrategyPlugins(): array - { - return [ - new ProductOfferReferenceStrategyPlugin(), - new DefaultProductOfferReferenceStrategyPlugin(), - ]; - } -} -``` - -**src/Pyz/Client/ProductStorage/ProductStorageDependencyProvider.php** - -```php - - */ - protected function getProductViewExpanderPlugins() - { - return [ - new ProductViewProductOfferExpanderPlugin(), - ]; - } -} -``` - -
src/Pyz/Zed/ProductOffer/ProductOfferDependencyProvider.php - -```php - - */ - protected function getProductOfferPostCreatePlugins(): array - { - return [ - new ProductOfferValidityProductOfferPostCreatePlugin(), - ]; - } - - /** - * @return array<\Spryker\Zed\ProductOfferExtension\Dependency\Plugin\ProductOfferPostUpdatePluginInterface> - */ - protected function getProductOfferPostUpdatePlugins(): array - { - return [ - new ProductOfferValidityProductOfferPostUpdatePlugin(), - ]; - } - - /** - * @return array<\Spryker\Zed\ProductOfferExtension\Dependency\Plugin\ProductOfferExpanderPluginInterface> - */ - protected function getProductOfferExpanderPlugins(): array - { - return [ - new ProductOfferValidityProductOfferExpanderPlugin(), - ]; - } -} -``` -
- -**src/Pyz/Zed/Console/ConsoleDependencyProvider.php** - -```php - - */ - protected function getConsoleCommands(Container $container) - { - $commands = [ - new ProductOfferValidityConsole(), - ]; - - return $commands; - } -} -``` - -**src/Pyz/Zed/ProductOfferStorage/ProductOfferStorageDependencyProvider.php** - -```php - - */ - protected function getProductOfferStorageMapperPlugins(): array - { - return [ - new MerchantProductOfferStorageMapperPlugin(), - ]; - } -} -``` - -{% info_block warningBox "Verification" %} - -Make sure the following is true: -* A default product offer is given when retrieving product concrete data. -* Validity data is saved when saving a product offer. -* Merchant and Product Offer Validity sections exist on the product offer view page in `ProductOfferGui`. -* The Merchant column is in the Product Offers list in `ProductOfferGui`. -* The console command invalidates expired product offers and reactivates product offers that are within their validity dates. - -Make sure that when a merchant gets updated or published, or when a product offer gets published, created, or updated, the corresponding product abstracts get updated in the catalog search pages. It means the following: -* If a merchant gets deactivated, `ProductAbstract` products that are on the catalog search only because they have a product offer from that merchant get removed. -* If a product offer gets created, and the `ProductAbstract` product related to it is not available on catalog search, it gets available. - -{% endinfo_block %} - -### 7) Configure navigation - -1. Add product offers section to marketplace section of `navigation.xml`: - -**config/Zed/navigation.xml** - -```xml - - - - - - - Offers - product-offer-gui - list - index - - - - -``` - -2. Execute the following command: - -```bash -console navigation:build-cache -``` - -{% info_block warningBox "Verification" %} - -Make sure that in the navigation menu of the Back Office, you can see the **Marketplace> Offers** menu item. - -{% endinfo_block %} - -## Install feature frontend - -Follow the steps below to install the Marketplace Product Offer feature frontend. - -### Prerequisites - -To start feature integration, integrate the following features: - -| NAME | VERSION | INTEGRATION GUIDE | -| ---------- | ----- | --------------| -| Spryker Core | {{page.version}} | [Spryker Core feature integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/spryker-core-feature-integration.html) | -| Marketplace Merchant | {{page.version}} | [Marketplace Merchant feature integration](/docs/pbc/all/merchant-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-merchant-feature-merchant-feature.html) | - -### 1) Install the required modules using Composer - -Not needed if installed earlier. - -{% info_block warningBox "Verification" %} - -Verify that the following modules have been installed: - -| MODULE | EXPECTED DIRECTORY | -|----------------------------|--------------------------------------------| -| MerchantProductOfferWidget | spryker-shop/merchant-product-offer-widget | -| ProductOfferWidget | spryker-shop/product-offer-widget | -| MerchantProductOfferWidgetExtension | spryker-shop/merchant-product-offer-widget-extension | - -{% endinfo_block %} - -### 2) Add translations - -1. Append glossary according to your configuration: - -**data/import/common/common/glossary.csv** - -``` -merchant_product_offer.view_seller,View Seller,en_US -merchant_product_offer.view_seller,Händler ansehen,de_DE -merchant_product_offer.sold_by,Sold by,en_US -merchant_product_offer.sold_by,Verkauft durch,de_DE -product-offer.info.product-offer-inactive.removed,Inactive item %sku% was removed from your shopping cart.,en_US -product-offer.info.product-offer-inactive.removed,Der inaktive Artikel %sku% wurde aus Ihrem Warenkorb entfernt.,de_DE -product-offer.info.reference.invalid,Product offer reference not found for product with SKU '%sku%'.,en_US -product-offer.info.reference.invalid,Produktangebotsreferenz für Produkt mit SKU '% sku%' nicht gefunden.,de_DE -product-offer.message.not-active-or-approved,"Product offer not active for product with SKU '%sku%'.",en_US -product-offer.message.not-active-or-approved,"Produktangebot ist inaktiv für Produkt mit SKU '%sku%'.",de_DE -merchant_product_offer_widget.merchant_name,Merchant,en_US -merchant_product_offer_widget.merchant_name,Händler,de_DE -``` - -2. Import data: - -```bash -console data:import glossary -``` - -{% info_block warningBox "Verification" %} - -Make sure that the configured data is added to the `spy_glossary_key` and `spy_glossary_translation` tables in the database. - -{% endinfo_block %} - -### 3) Enable controllers - -Register the following route provider on the Storefront: - -| PROVIDER | NAMESPACE | -| --- | --- | -| MerchantProductOfferWidgetRouteProviderPlugin | | SprykerShop\Yves\MerchantProductOfferWidget\Plugin\Router | - -**src/Pyz/Yves/Router/RouterDependencyProvider.php** - -```php - - */ - protected function getGlobalWidgets(): array - { - return [ - MerchantProductOfferWidget::class, - MerchantProductOffersSelectWidget::class, - ]; - } -} -``` - -Enable Javascript and CSS changes: - -```bash -console frontend:yves:build -``` - -{% info_block warningBox "Verification" %} - -Make sure that the following widgets have been registered: - -| MODULE | TEST | -| ----------------- | ----------------- | -| MerchantProductOfferWidget | Go to a product concrete details page that has offers. You can see that the default offer is selected, and the widget is displayed. | -| MerchantProductOffersSelectWidget | Make sure that `ProductConcreteAddWidget` renders a product offers list after performing a product search. | - -{% endinfo_block %} - -### 5) Set up behavior - -Enable the following behaviors by registering the plugins: - -| PLUGIN | DESCRIPTION | PREREQUISITES | NAMESPACE | -|---------------|-------------|---------------|------------| -| MerchantProductOfferProductQuickAddFormExpanderPlugin | Expands `ProductQuickAddForm` with `product_offer_reference` hidden field. | | SprykerShop\Yves\MerchantProductOfferWidget\Plugin\ProductSearchWidget | - -**src/Pyz/Yves/ProductSearchWidget/ProductSearchWidgetDependencyProvider.php** - -```php - - */ - protected function getProductQuickAddFormExpanderPlugins(): array - { - return [ - new MerchantProductOfferProductQuickAddFormExpanderPlugin(), - ]; - } -} -``` - -## Related features - -| FEATURE | REQUIRED FOR THE CURRENT FEATURE | INTEGRATION GUIDE | -|--------------|---------------|-----------------| -| Combined Product Offer Import | | [Combined Product Offer Import integration](/docs/marketplace/dev/feature-integration-guides/{{page.version}}/combined-product-offer-import-feature-integration.html) | -| Marketplace Product Offer Prices | | [Marketplace Product Offer Prices feature integration](/docs/pbc/all/price-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-prices-feature.html) | -| Marketplace Merchant Portal Product Offer Management | | [Marketplace Product Offer Management feature integration](/docs/marketplace/dev/feature-integration-guides/{{page.version}}/marketplace-merchant-portal-product-offer-management-feature-integration.html) | -| Marketplace Product Offer API | | [Glue API: Marketplace Product Offer feature integration](/docs/marketplace/dev/feature-integration-guides/{{page.version}}/glue/marketplace-product-offer-feature-integration.html) | -| Marketplace Product + Marketplace Product Offer | | [Marketplace Product + Marketplace Product Offer feature integration](/docs/pbc/all/product-information-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-marketplace-product-offer-feature.html) | -| Marketplace Product Offer + Cart | | [Marketplace Product Offer + Cart feature integration](/docs/marketplace/dev/feature-integration-guides/{{page.version}}/marketplace-product-offer-cart-feature-integration.html) | -| Marketplace Product Offer + Checkout | | [Marketplace Product Offer + Checkout feature integration](/docs/marketplace/dev/feature-integration-guides/{{page.version}}/marketplace-product-offer-checkout-feature-integration.html) | -| Marketplace Product Offer + Prices | | [Marketplace Product Offer + Prices feature integration](/docs/pbc/all/price-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-prices-feature.html) | -| Marketplace Product Offer + Quick Add to Cart | | [Marketplace Product Offer + Quick Add to Cart feature integration](/docs/pbc/all/offer-management/{{page.version}}/marketplace/install-and-upgrade/install-features/install-the-marketplace-product-offer-quick-add-to-cart-feature.html) | +{% include pbc/all/install-features/{{page.version}}/marketplace/install-the-marketplace-product-offer-feature.md %}